From cfd19d22cbc139a9efc1c718cef8caf23439a938 Mon Sep 17 00:00:00 2001 From: rikard Date: Tue, 21 Apr 2026 11:09:07 +0200 Subject: [PATCH 1/5] fix: ETU-67083: Testing lint of big spec --- .github/workflows/ci.yml | 9 +- fixture/openapi-big.json | 61080 +++++++++++++++++++++++++++++++++++++ 2 files changed, 61088 insertions(+), 1 deletion(-) create mode 100644 fixture/openapi-big.json diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a8b712b..f6324b1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -87,4 +87,11 @@ jobs: uses: ./.github/workflows/validate.yml with: artifact: "specs" - path: "openapi-good.json" \ No newline at end of file + path: "openapi-good.json" + + test-lint-big: + uses: ./.github/workflows/lint.yml + with: + path: fixture/openapi-big.json + upload_to_bucket: false + fail_threshold: error \ No newline at end of file diff --git a/fixture/openapi-big.json b/fixture/openapi-big.json new file mode 100644 index 0000000..bdf66ad --- /dev/null +++ b/fixture/openapi-big.json @@ -0,0 +1,61080 @@ +{ + "openapi": "3.0.1", + "info": { + "description": "This API provides services to read and maintain products and fare data for public transport in Norway.", + "title": "Products", + "version": "0.0.1", + "x-entur-metadata": { + "audience": "partner", + "id": "products", + "owner": "team-produkt" + } + }, + "servers": [ + { + "url": "https://api.entur.io/products", + "description": "Production environment" + }, + { + "url": "https://api.staging.entur.io/products", + "description": "Staging environment" + }, + { + "url": "https://api.dev.entur.io/products", + "description": "Development environment" + } + ], + "security": [ + { + "jwt": [] + } + ], + "tags": [ + { + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "name": "supplement-products" + } + ], + "paths": { + "/admin/bucket-invalidation": { + "post": { + "operationId": "admin/bucket-invalidation_invalidateAll", + "responses": { + "202": { + "description": "Invalidation started" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Invalidate and rebuild GCS buckets for all entity types", + "tags": [ + "admin/bucket-invalidation" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/bucket-invalidation/{entityType}": { + "post": { + "operationId": "admin/bucket-invalidation_invalidateEntityType", + "parameters": [ + { + "description": "Entity type: SalesPackage, FarePrice, FareTable, SaleDiscountRight, or UserProfile", + "in": "path", + "name": "entityType", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Invalidation started" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Invalid entity type" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Invalidate and rebuild GCS bucket for a specific entity type", + "tags": [ + "admin/bucket-invalidation" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/delete": { + "put": { + "operationId": "admin/cache_deleteEntityByObject", + "parameters": [ + { + "description": "Specify this if you want to delete all elements connected to a specific type of entity. I.e. \u0027fare_structure_element\u0027 or \u0027fare_table\u0027 etc.", + "in": "query", + "name": "nameOfEntity", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "integer", + "format": "int64" + } + } + }, + "description": "Successfully deleted" + }, + "204": { + "content": { + "*/*": { + "schema": { + "type": "integer", + "format": "int64" + } + } + }, + "description": "No content. Deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete all elements in cache or delete specific element given key in req.body", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/delete/all": { + "put": { + "operationId": "admin/cache_deleteAllEntitiesFromCache", + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + }, + "description": "Successfully deleted" + }, + "204": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + }, + "description": "No content. Deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete all elements in cache", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/invalidate": { + "put": { + "operationId": "admin/cache_invalidateCache", + "parameters": [ + { + "description": "Specify this if you want to invalidate cache for elements connected to a specific type of entity. I.e. \u0027fare_structure_element\u0027 or \u0027fare_table\u0027 etc. . If no value given all cache will be invalidated", + "in": "query", + "name": "nameOfEntity", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "If set to true the whole cache will be invalidated. If false only the cache for the specified entity will be invalidated. Default is false.", + "in": "query", + "name": "all", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + }, + "description": "Successfully deleted" + }, + "204": { + "content": { + "*/*": { + "schema": { + "type": "string" + } + } + }, + "description": "No content. Deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete all elements in cache", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/keys/count": { + "get": { + "operationId": "admin/cache_getCount", + "parameters": [ + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "integer", + "format": "int64" + } + } + }, + "description": "Successfully" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Count the DB size of Redis", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/keys/count/{keyOfEntity}": { + "get": { + "operationId": "admin/cache_getCount_1", + "parameters": [ + { + "in": "path", + "name": "keyOfEntity", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "integer", + "format": "int64" + } + } + }, + "description": "Successfully" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Count number of elements in cache by key of entity", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/keys/info": { + "get": { + "operationId": "admin/cache_getKeyInfo", + "parameters": [ + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetString" + } + } + }, + "description": "Successfully" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get key info for entities in cache", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/keys/info/{nameOfEntity}": { + "get": { + "operationId": "admin/cache_getKeyInfo_1", + "parameters": [ + { + "in": "path", + "name": "nameOfEntity", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SetString" + } + } + }, + "description": "Successfully" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get key info for a given entity in cache", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/admin/cache/status": { + "get": { + "operationId": "admin/cache_getCacheStatuses", + "parameters": [ + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MapStringObject" + } + } + }, + "description": "Successfully retrieved cache statuses" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get cache statuses for all entities", + "tags": [ + "admin/cache" + ], + "x-entur-permissions": { + "value": "product-admin-api-access:endre" + } + } + }, + "/amount-of-price-unit-products": { + "get": { + "operationId": "amount-of-price-unit-products_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id for the language", + "in": "query", + "name": "language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AmountOfPriceUnitProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves an amount of price unit products, filtered by given parameter(s)", + "tags": [ + "amount-of-price-unit-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "amount-of-price-unit-products_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AmountOfPriceUnitProduct" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create an AmountOfPriceUnitProduct", + "tags": [ + "amount-of-price-unit-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/amount-of-price-unit-products/{id}": { + "get": { + "operationId": "amount-of-price-unit-products_getById", + "parameters": [ + { + "description": "The unique id to identify the amount of price unit product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the amount of price unit product", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AmountOfPriceUnitProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of an AmountOfPriceUnitProduct by id", + "tags": [ + "amount-of-price-unit-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/amount-of-price-unit-products/{id}/{version}": { + "get": { + "operationId": "amount-of-price-unit-products_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify the an amount of price unit product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the amount of price unit product", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AmountOfPriceUnitProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves an AmountOfPriceUnitProduct by id and version", + "tags": [ + "amount-of-price-unit-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "amount-of-price-unit-products_update", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the amount of price unit product", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AmountOfPriceUnitProduct" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update an AmountOfPriceUnitProduct parameter.", + "tags": [ + "amount-of-price-unit-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/availability-conditions": { + "get": { + "operationId": "availability-conditions_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AvailabilityCondition" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all availability condition parameters", + "tags": [ + "availability-conditions" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "availability-conditions_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AvailabilityCondition" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a Availability Condition", + "tags": [ + "availability-conditions" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/availability-conditions/{id}/{version}": { + "delete": { + "operationId": "availability-conditions_deleteById", + "parameters": [ + { + "description": "The id to identify a Availability Condition", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Availability Condition", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an AvailabilityCondition by id and version", + "tags": [ + "availability-conditions" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "availability-conditions_getById", + "parameters": [ + { + "description": "The id to identify a Availability Condition ", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Availability Condition", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AvailabilityCondition" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves Availability Condition for id and version", + "tags": [ + "availability-conditions" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "availability-conditions_update", + "parameters": [ + { + "description": "The id to identify a Availability Condition", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Availability Condition", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AvailabilityCondition" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing Availability Condition", + "tags": [ + "availability-conditions" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/capped-discount-rights": { + "get": { + "operationId": "capped-discount-rights_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "The unique id for the language", + "in": "query", + "name": "language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CappedDiscountRight" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a capped discount right, filtered by given parameter(s)", + "tags": [ + "capped-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "capped-discount-rights_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CappedDiscountRightInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a capped discount right", + "tags": [ + "capped-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/capped-discount-rights/{id}": { + "get": { + "operationId": "capped-discount-rights_getById", + "parameters": [ + { + "description": "The unique id to identify the capped discount right", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the capped discount right", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Toggles whether you want to find latest version or latest active version for specific environment, so in staging that would be a proposed version, while in production it will only be a versioned version", + "in": "query", + "name": "findActiveInEnvironment", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CappedDiscountRight" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of a capped discount right by id", + "tags": [ + "capped-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/capped-discount-rights/{id}/{version}": { + "get": { + "operationId": "capped-discount-rights_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify the capped discount right", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the capped discount right", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CappedDiscountRight" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a capped discount right by id and version", + "tags": [ + "capped-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "capped-discount-rights_update", + "parameters": [ + { + "description": "The unique id to identify the capped discount right", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the capped discount right", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CappedDiscountRightInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a capped discount right", + "tags": [ + "capped-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/charging-moments": { + "post": { + "operationId": "charging-moments_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChargingMomentInsert" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a charging moment controller", + "tags": [ + "charging-moments" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/charging-moments/{id}/{version}": { + "get": { + "operationId": "charging-moments_getByIdAndVersion", + "parameters": [ + { + "description": "The id to identify a ChargingMooment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ChargingMoment", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChargingMoment" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves charging moment for id and version", + "tags": [ + "charging-moments" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/charging-policies": { + "get": { + "operationId": "charging-policies_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChargingPolicy" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all charging policies", + "tags": [ + "charging-policies" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/companion-profiles": { + "get": { + "deprecated": true, + "operationId": "companion-profiles_findByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanionProfile" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all companion profile", + "tags": [ + "companion-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/companion-profiles/{id}/{version}": { + "get": { + "deprecated": true, + "operationId": "companion-profiles_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a companion profile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the companion profile", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanionProfile" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a companion profile by id and version", + "tags": [ + "companion-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/day-types": { + "get": { + "operationId": "day-types_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DayType" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all day types", + "tags": [ + "day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "day-types_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DayType" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a dayType", + "tags": [ + "day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/day-types/{id}/{version}": { + "delete": { + "operationId": "day-types_deleteById", + "parameters": [ + { + "description": "The id to identify a day type", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the day type", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an day type given by id and version", + "tags": [ + "day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "day-types_getById", + "parameters": [ + { + "description": "The id to identify a DayType", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the DayType", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DayType" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves day type for id and version", + "tags": [ + "day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "day-types_update", + "parameters": [ + { + "description": "The id to identify a DayType", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the DayType", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DayType" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing DayType", + "tags": [ + "day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/distance-matrix-elements": { + "get": { + "operationId": "distance-matrix-elements_findByGroupIdOrVersionOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The netexId to identify group the distance matrix elements belong to", + "in": "query", + "name": "groupId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version of the group the distance matrix elements belong to", + "in": "query", + "name": "groupVersion", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The page of the pagination", + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The size of the page", + "in": "query", + "name": "pageSize", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DistanceMatrixElement" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves distance matrix elements and filter by query params", + "tags": [ + "distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "distance-matrix-elements_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DistanceMatrixElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a DistanceElement", + "tags": [ + "distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/distance-matrix-elements/batch/{version}": { + "put": { + "operationId": "distance-matrix-elements_updateMany", + "parameters": [ + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DistanceMatrixElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update batch of distance matrix elements", + "tags": [ + "distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/distance-matrix-elements/{id}/{version}": { + "get": { + "operationId": "distance-matrix-elements_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a charging moment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DistanceMatrixElement" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a distance-matrix-elements by id and version", + "tags": [ + "distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/distribution-channel-usages/{id}": { + "get": { + "operationId": "distribution-channel-usages_getById", + "parameters": [ + { + "description": "The netex-id for a given distributionChannel the service should fong refences for.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves references where the distribution-channel with given id is referenced", + "tags": [ + "distribution-channel-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/entitlement-given": { + "get": { + "operationId": "entitlement-given_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntitlementGiven" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all entitlement given", + "tags": [ + "entitlement-given" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "entitlement-given_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitlementGiven" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a EntitlementGiven", + "tags": [ + "entitlement-given" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/entitlement-given/{id}/{version}": { + "delete": { + "operationId": "entitlement-given_deleteById", + "parameters": [ + { + "description": "The id to identify an entitlement given", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the entitlement given", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an entitlement given by id and version", + "tags": [ + "entitlement-given" + ] + }, + "get": { + "operationId": "entitlement-given_getById", + "parameters": [ + { + "description": "The id to identify a EntitlementGiven", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the EntitlementGiven", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EntitlementGiven" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves entitlement given for id and version", + "tags": [ + "entitlement-given" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "entitlement-given_update", + "parameters": [ + { + "description": "The id to identify a EntitlementGiven", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the EntitlementGiven", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitlementGiven" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing EntitlementGiven", + "tags": [ + "entitlement-given" + ] + } + }, + "/entitlement-products": { + "get": { + "operationId": "entitlement-products_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntitlementProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves entitlement-products by organisation id and fare frame id", + "tags": [ + "entitlement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/entitlements-required": { + "get": { + "operationId": "entitlements-required_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EntitlementRequired" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all entitlements required", + "tags": [ + "entitlements-required" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "entitlements-required_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitlementRequired" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create an EntitlementRequired", + "tags": [ + "entitlements-required" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/entitlements-required/{id}/{version}": { + "delete": { + "operationId": "entitlements-required_deleteById", + "parameters": [ + { + "description": "The id to identify an EntitlementRequired", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the EntitlementRequired", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an EntitlementRequired by id and version", + "tags": [ + "entitlements-required" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "entitlements-required_getById", + "parameters": [ + { + "description": "The id to identify a EntitlementRequired", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the EntitlementRequired", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/EntitlementRequired" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves EntitlementRequired for id and version", + "tags": [ + "entitlements-required" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "entitlements-required_update", + "parameters": [ + { + "description": "The id to identify a EntitlementRequired", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the EntitlementRequired", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitlementRequired" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing EntitlementRequired", + "tags": [ + "entitlements-required" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/exchanging": { + "get": { + "operationId": "exchanging_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Languagecode", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "summary": "Retrieves all exchanging rules", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "exchanging_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExchangingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create an exchanging rule", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/exchanging-possibilities": { + "post": { + "operationId": "exchanging-possibilities_getExchangingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ParameterPossibilitiesRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExchangingAlternatives" + } + } + } + }, + "description": "Returns the resource." + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves exchanging rules for given elements", + "tags": [ + "exchanging-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging-possibilities/fare-structure-element/{id}/{version}": { + "get": { + "operationId": "exchanging-possibilities_getFSEExchangingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id to identify a fare structure element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves exchanging rules for given elements", + "tags": [ + "exchanging-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging-possibilities/preassigned-product/{id}/{version}": { + "get": { + "operationId": "exchanging-possibilities_getFPExchangingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves exchanging rules for given elements", + "tags": [ + "exchanging-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging-possibilities/sales-package/{id}/{version}": { + "get": { + "operationId": "exchanging-possibilities_getSPExchangingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a sales package.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves exchanging rules for given elements", + "tags": [ + "exchanging-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging-possibilities/validable-element/{id}/{version}": { + "get": { + "operationId": "exchanging-possibilities_getVEExchangingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id to identify a validable element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves exchanging rules for given elements", + "tags": [ + "exchanging-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging/{id}": { + "get": { + "operationId": "exchanging_getById", + "parameters": [ + { + "description": "The unique id to identify an exchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the purchase window", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Exchanging" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "summary": "Retrieves an exchanging rule by id", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/exchanging/{id}/{version}": { + "get": { + "operationId": "exchanging_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify an exchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the exchanging", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Exchanging" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "summary": "Retrieves an exchanging rule by id and version", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "exchanging_update", + "parameters": [ + { + "description": "The unique id to identify an exchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the exchanging", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExchangingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "summary": "Update exchanging rule", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-day-types": { + "get": { + "operationId": "fare-day-types_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareDayType" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all fare day types", + "tags": [ + "fare-day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fare-day-types_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareDayType" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a fare day Type", + "tags": [ + "fare-day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-day-types/{id}/{version}": { + "delete": { + "operationId": "fare-day-types_deleteById", + "parameters": [ + { + "description": "The id to identify a fare day type", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fare day type", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an day type given by id and version", + "tags": [ + "fare-day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "fare-day-types_getById", + "parameters": [ + { + "description": "The id to identify a fare day type", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fare day type", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareDayType" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fare day type for id and version", + "tags": [ + "fare-day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fare-day-types_update", + "parameters": [ + { + "description": "The id to identify a fare day type", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fare day type", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareDayType" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing fare day type", + "tags": [ + "fare-day-types" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-frames": { + "get": { + "operationId": "fare-frames_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareFrame" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fare frames by organisation id", + "tags": [ + "fare-frames" + ] + } + }, + "/fare-frames/{id}": { + "get": { + "operationId": "fare-frames_getById", + "parameters": [ + { + "description": "The unique id to identify a fareFrames", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fareFrames", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareFrame" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a fareFrames by id", + "tags": [ + "fare-frames" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-frames/{id}/{version}": { + "get": { + "operationId": "fare-frames_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a fareFrames", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fareFrames", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareFrame" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a fareFrames by id and version.", + "tags": [ + "fare-frames" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-products": { + "get": { + "operationId": "fare-products_findByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify the type of fare product", + "in": "query", + "name": "typeOfFareProductId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all fare-products, filtered by given parameter(s)", + "tags": [ + "fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-quota-factors": { + "get": { + "operationId": "fare-quota-factors_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareQuotaFactor" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all fare quota factors given", + "tags": [ + "fare-quota-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fare-quota-factors_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareQuotaFactor" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a fareQuotaFactor", + "tags": [ + "fare-quota-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-quota-factors/{id}/{version}": { + "delete": { + "operationId": "fare-quota-factors_deleteById", + "parameters": [ + { + "description": "The id to identify a FareQuotaFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareQuotaFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a FareQuotaFactor by id and version", + "tags": [ + "fare-quota-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "fare-quota-factors_getById", + "parameters": [ + { + "description": "The id to identify a FareQuotaFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareQuotaFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareQuotaFactor" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fare quota factor for id and version", + "tags": [ + "fare-quota-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fare-quota-factors_update", + "parameters": [ + { + "description": "The id to identify a FareQuotaFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareQuotaFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareQuotaFactor" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing FareQuotaFactor", + "tags": [ + "fare-quota-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-sections": { + "get": { + "operationId": "fare-sections_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareSection" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all fare sections", + "tags": [ + "fare-sections" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fare-sections_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareSection" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a fareSection", + "tags": [ + "fare-sections" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-sections/{id}/{version}": { + "delete": { + "operationId": "fare-sections_deleteById", + "parameters": [ + { + "description": "The id to identify a FareSection", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareSection", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a FareSection by id and version", + "tags": [ + "fare-sections" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "fare-sections_getById", + "parameters": [ + { + "description": "The id to identify a FareSection", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareSection", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalStructureFactor" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fare section for id and version", + "tags": [ + "fare-sections" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fare-sections_update", + "parameters": [ + { + "description": "The id to identify a FareSection", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FareSection", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareSection" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing FareSection", + "tags": [ + "fare-sections" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-structure-element-usages/{id}": { + "get": { + "operationId": "fare-structure-element-usages_getMinimalVersionInfoById", + "parameters": [ + { + "description": "The netex_id to identify a FareStructureElement", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MininmalVersionInfo" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves products/validable elements where the given FareStructureElement-id is referenced", + "tags": [ + "fare-structure-element-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-structure-elements": { + "get": { + "operationId": "fare-structure-elements_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset for an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "$ref": "#/components/schemas/SeqStatusFilterEnum" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareStructureElement" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a preassignedFareProduct by organisation id", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fare-structure-elements_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareStructureElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a Fare structure element", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-structure-elements/count": { + "get": { + "operationId": "fare-structure-elements_getCount", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "$ref": "#/components/schemas/SeqStatusFilterEnum" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Count" + } + } + }, + "description": "Entity updated successfully" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-structure-elements/pages": { + "get": { + "operationId": "fare-structure-elements_findPageByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements listed in requested page", + "in": "query", + "name": "pageSize", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The given page one want in return", + "in": "query", + "name": "pageNumber", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "$ref": "#/components/schemas/SeqStatusFilterEnum" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareStructureElementPageWrapper" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-structure-elements/{id}": { + "get": { + "operationId": "fare-structure-elements_getById", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FareStructureElement" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a fare structure element by netexId", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-structure-elements/{id}/{version}": { + "get": { + "operationId": "fare-structure-elements_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/FareStructureElement" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a fare structure element by id and version", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fare-structure-elements_update", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareStructureElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a fare structure element", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-structure-elements/{id}/{version}/distance-matrix-elements": { + "get": { + "deprecated": true, + "description": "No longer in use. DMEs are connected by geographicalStructureFactors", + "operationId": "fare-structure-elements_getPointToPointFares", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The limited numbers of distance matrix elements returned in the set", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The offset of distance matrix elements returned in the set", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DistanceMatrixElement" + } + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the distance matrix elements of the fare structure element", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-structure-elements/{id}/{version}/geographical-intervals": { + "get": { + "operationId": "fare-structure-elements_getGeographicalIntervals", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The limited numbers of geographical intervals returned in the set", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The offset of geographical intervals returned in the set", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicalInterval" + } + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the geographical intervals of the fare structure element", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-table-usages/{id}": { + "get": { + "operationId": "fare-table-usages_getById", + "parameters": [ + { + "description": "The netex_id to identify a fare table ", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves references where the given fare table id is referenced", + "tags": [ + "fare-table-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-tables": { + "get": { + "operationId": "fare-tables_findByOrganisationIdOrFareFrameId", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "if set to true fare table cells will be omitted", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareTable" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all faretables. Limiting selection by fareFrameId parameter is supported", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fare-tables_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareTableInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a fare table", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-tables/count": { + "get": { + "operationId": "fare-tables_getFareTableCount", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count" + } + } + }, + "description": "Returs the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of fareTables. Limiting selection by fareFrameId and orgId parameter is supported", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-tables/pages": { + "get": { + "operationId": "fare-tables_findPageByOrganisationIdOrFareFrameId", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Size of page", + "in": "query", + "name": "pageSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Page number", + "in": "query", + "name": "pageNumber", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "if set to true fare table cells will be omitted", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareTablePageWrapper" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fareTables for a given page. Limiting selection by fareFrameId and orgId parameter is supported", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-tables/products/{id}": { + "get": { + "operationId": "fare-tables_getByFareProductId", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareTable" + } + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a faretable by product id", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-tables/{ftId}/cells/{cellId}/fare-prices": { + "patch": { + "operationId": "fare-tables_updateFarePriceForFareTable", + "parameters": [ + { + "description": "The id to identify a fare table", + "in": "path", + "name": "ftId", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id to identify a cell", + "in": "path", + "name": "cellId", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "version", + "required": true, + "schema": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The versjon of the fare table", + "in": "query", + "name": "fareTableVersionId", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FarePriceUpdate" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates a FarePrice for FareTable", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fare-tables/{id}": { + "get": { + "description": "Note! Only fare tables with active versions will be fetched", + "operationId": "fare-tables_getById", + "parameters": [ + { + "description": "The unique id to identify a fare table", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The id for the version of the fare table", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "if set to true fare table cells will be omitted", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareTable" + } + } + }, + "description": "Returns the fare table" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a fare table by id", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/fare-tables/{id}/{version}": { + "get": { + "operationId": "fare-tables_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a fare table", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The id for the version of the fare table", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "if set to true fare table cells will be omitted", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareTable" + } + } + }, + "description": "Returns the fare table" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a fare table by id and version", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fare-tables_update", + "parameters": [ + { + "description": "The unique id to identify a fare table", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the fare table", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FareTableInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a faretable", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/frequencies-of-use": { + "get": { + "operationId": "frequencies-of-use_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FrequencyOfUse" + } + } + } + }, + "description": "Returns the frequencies of use" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all frequencies of use", + "tags": [ + "frequencies-of-use" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "frequencies-of-use_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyOfUseInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a frequency-of-use", + "tags": [ + "frequencies-of-use" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/frequencies-of-use/{id}/{version}": { + "get": { + "operationId": "frequencies-of-use_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a frequency of use", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the frequency of use", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyOfUse" + } + } + }, + "description": "Returns the frequencies of use" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves frequencies of use by id and version", + "tags": [ + "frequencies-of-use" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "frequencies-of-use_update", + "parameters": [ + { + "description": "The unique id to identify a frequency of use", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the frequency of use", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FrequencyOfUseInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a frequency of use parameter.", + "tags": [ + "frequencies-of-use" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fulfilment-methods": { + "get": { + "operationId": "fulfilment-methods_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FulfilmentMethod" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all fulfilment methods", + "tags": [ + "fulfilment-methods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "fulfilment-methods_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FulfilmentMethod" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a FulfilmentMethod", + "tags": [ + "fulfilment-methods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/fulfilment-methods/{id}/{version}": { + "delete": { + "operationId": "fulfilment-methods_deleteById", + "parameters": [ + { + "description": "The id to identify a FulfilmentMethod", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FulfilmentMethod", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a FulfilmentMethod by id and version", + "tags": [ + "fulfilment-methods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "fulfilment-methods_getById", + "parameters": [ + { + "description": "The id to identify a FulfilmentMethod", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FulfilmentMethod", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FulfilmentMethod" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves fulfilment method for id and version", + "tags": [ + "fulfilment-methods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "fulfilment-methods_update", + "parameters": [ + { + "description": "The id to identify a FulfilmentMethod", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the FulfilmentMethod", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FulfilmentMethod" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing FulfilmentMethod", + "tags": [ + "fulfilment-methods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/general-groups-of-entities": { + "get": { + "operationId": "general-groups-of-entities_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeneralGroupOfEntities" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all general groups of entities parameters", + "tags": [ + "general-groups-of-entities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "general-groups-of-entities_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeneralGroupOfEntities" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a general group of entities", + "tags": [ + "general-groups-of-entities" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/general-groups-of-entities/{id}/{version}": { + "delete": { + "operationId": "general-groups-of-entities_deleteById", + "parameters": [ + { + "description": "The id to identify a general group of entities", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the general group of entities", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete a general group of entities given id and version", + "tags": [ + "general-groups-of-entities" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "general-groups-of-entities_getById", + "parameters": [ + { + "description": "The id to identify a GeneralGroupOfEntities", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the GeneralGroupOfEntities", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GeneralGroupOfEntities" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves general group of entities given id and version", + "tags": [ + "general-groups-of-entities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "general-groups-of-entities_update", + "parameters": [ + { + "description": "The id to identify a general group of entities", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the general group of entities", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeneralGroupOfEntities" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing general group of entities", + "tags": [ + "general-groups-of-entities" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/generic-parameter-assignments": { + "get": { + "operationId": "generic-parameter-assignments_getAll", + "parameters": [ + { + "description": "The unique id to identify the data owner.", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify the data set to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Specify with \u0027a\u0027 or \u0027e\u0027 what set of gpa implementation should be retrieved", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "$ref": "#/components/schemas/SeqStatusFilterEnum" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves generic parameter assignment by fare frame id or organisation", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "generic-parameter-assignments_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenericParameterAssignmentInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a generic parameter assignment", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/generic-parameter-assignments/batch": { + "post": { + "operationId": "generic-parameter-assignments_createMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenericParameterAssignmentInsert" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entities created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create many generic parameter assignments", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/generic-parameter-assignments/{id}": { + "get": { + "operationId": "generic-parameter-assignments_getById", + "parameters": [ + { + "description": "The unique id to identify a generic parameter assignment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the generic parameter assignment", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a generic parameter assignment by id", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/generic-parameter-assignments/{id}/{version}": { + "get": { + "operationId": "generic-parameter-assignments_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a generic parameter assignment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the generic parameter assignment", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a generic parameter assignment by id and version", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "generic-parameter-assignments_update", + "parameters": [ + { + "description": "The unique id to identify a generic parameter assignment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the generic parameter assignment", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenericParameterAssignmentInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a generic parameter assignment", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/geographical-intervals": { + "post": { + "operationId": "geographical-intervals_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalIntervalInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a GeographicalInterval", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/geographical-intervals/batch": { + "post": { + "operationId": "geographical-intervals_createMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a list of GeographicalIntervals", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "put": { + "operationId": "geographical-intervals_updateMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update multiple geographical intervals", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/geographical-intervals/{giId}/fare-prices/{fpId}": { + "patch": { + "operationId": "geographical-intervals_updateFarePrice", + "parameters": [ + { + "description": "The id to identify a geographical interval", + "in": "path", + "name": "giId", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id to identify a fare price", + "in": "path", + "name": "fpId", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version id to identify a geographical interval", + "in": "query", + "name": "giVersionId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FarePriceUpdate" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update price for a geographical interval by netexId", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/geographical-intervals/{id}": { + "get": { + "operationId": "geographical-intervals_getById", + "parameters": [ + { + "description": "The unique id to identify a geographical interval", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the geographical interval", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalInterval" + } + } + }, + "description": "Returns the geographical interval" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a geographical interval by id", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/geographical-intervals/{id}/{version}": { + "get": { + "operationId": "geographical-intervals_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a geographical interval", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the geographical interval", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalInterval" + } + } + }, + "description": "Returns the geographical interval" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a geographical interval by id and version", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/geographical-structure-factors": { + "get": { + "operationId": "geographical-structure-factors_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicalStructureFactor" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all geographical structure factors", + "tags": [ + "geographical-structure-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "geographical-structure-factors_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalStructureFactor" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a GeographicalStructureFactor", + "tags": [ + "geographical-structure-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/geographical-structure-factors-usages/{id}": { + "get": { + "operationId": "geographical-structure-factors-usages_getById", + "parameters": [ + { + "description": "The netex_id to identify a GeographicalStructureFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves references where the given GeographicalStructureFactor id is referenced", + "tags": [ + "geographical-structure-factors-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/geographical-structure-factors/{id}/{version}": { + "delete": { + "operationId": "geographical-structure-factors_deleteById", + "parameters": [ + { + "description": "The id to identify a GeographicalStructureFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the GeographicalStructureFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a GeographicalStructureFactor by id and version", + "tags": [ + "geographical-structure-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "geographical-structure-factors_getById", + "parameters": [ + { + "description": "The id to identify a GeographicalStructureFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the GeographicalStructureFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalStructureFactor" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves geographical structure factor for id and version", + "tags": [ + "geographical-structure-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "geographical-structure-factors_update", + "parameters": [ + { + "description": "The id to identify a GeographicalStructureFactor", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the GeographicalStructureFactor", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeographicalStructureFactor" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing GeographicalStructureFactor", + "tags": [ + "geographical-structure-factors" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/group-of-distance-matrix-elements": { + "get": { + "operationId": "group-of-distance-matrix-elements_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all groups of distance matrix elements", + "tags": [ + "group-of-distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "group-of-distance-matrix-elements_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupOfDistanceMatrixElementsInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a GroupOfDistanceElement", + "tags": [ + "group-of-distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/group-of-distance-matrix-elements/{id}/{version}": { + "get": { + "operationId": "group-of-distance-matrix-elements_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a GroupOfDistanceMatrixElements", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the GroupOfDistanceMatrixElements", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a GroupOfDistanceMatrixElementsEntity by id and version", + "tags": [ + "group-of-distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/group-tickets": { + "get": { + "operationId": "group-tickets_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupTicket" + } + } + } + }, + "description": "Returns all group tickets" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all group tickets accessible by user rights", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "group-tickets_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupTicketInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a group ticket", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/group-tickets/{id}": { + "get": { + "operationId": "group-tickets_getById", + "parameters": [ + { + "description": "The unique id to identify a group ticket", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the group ticket", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupTicket" + } + } + }, + "description": "Returns the group ticket" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a group ticket by id", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/group-tickets/{id}/{version}": { + "get": { + "operationId": "group-tickets_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a group ticket", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the group ticket", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupTicket" + } + } + }, + "description": "Returns the group ticket" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a group ticket by id and version", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "group-tickets_update", + "parameters": [ + { + "description": "The unique id to identify a group ticket", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the group ticket", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GroupTicket" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a group ticket", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/interchangings": { + "get": { + "operationId": "interchangings_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset for an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Interchanging" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all interchangings for a given fare frame", + "tags": [ + "interchangings" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "interchangings_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InterchangingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "Returns the info" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create an interchanging", + "tags": [ + "interchangings" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/interchangings/{id}/{version}": { + "get": { + "operationId": "interchangings_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a interchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the interchanging", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Interchanging" + } + } + }, + "description": "Returns the interchanging" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves an interchanging by id and version", + "tags": [ + "interchangings" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "interchangings_update", + "parameters": [ + { + "description": "The unique id to identify a interchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the interchanging", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InterchangingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update an interchanging", + "tags": [ + "interchangings" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/journey-patterns": { + "get": { + "operationId": "journey-patterns_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JourneyPattern" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all journey patterns", + "tags": [ + "journey-patterns" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "journey-patterns_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JourneyPattern" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a JourneyPattern", + "tags": [ + "journey-patterns" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/journey-patterns/{id}/{version}": { + "delete": { + "operationId": "journey-patterns_deleteById", + "parameters": [ + { + "description": "The id to identify a JourneyPattern", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the JourneyPattern", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a JourneyPattern by id and version", + "tags": [ + "journey-patterns" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "journey-patterns_getById", + "parameters": [ + { + "description": "The id to identify a JourneyPattern", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the JourneyPattern", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JourneyPattern" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves journey pattern for id and version", + "tags": [ + "journey-patterns" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "journey-patterns_update", + "parameters": [ + { + "description": "The id to identify a JourneyPattern", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the JourneyPattern", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JourneyPattern" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing JourneyPattern", + "tags": [ + "journey-patterns" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/luggage-allowances": { + "get": { + "operationId": "luggage-allowances_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LuggageAllowance" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all luggage allowances", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "luggage-allowances_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LuggageAllowance" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a luggage allowance", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/luggage-allowances/{id}/versions": { + "get": { + "operationId": "luggage-allowances_getVersionsOrActiveById", + "parameters": [ + { + "description": "The id to identify a LuggageAllowance", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", + "in": "query", + "name": "active", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LuggageAllowance" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves luggage allowance versions for a given id", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/luggage-allowances/{id}/{version}": { + "delete": { + "operationId": "luggage-allowances_deleteById", + "parameters": [ + { + "description": "The id to identify a LuggageAllowance", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The id for the version of the LuggageAllowance", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Entity deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete an existing LuggageAllowance", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "luggage-allowances_getById", + "parameters": [ + { + "description": "The id to identify a LuggageAllowance", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the LuggageAllowance", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LuggageAllowance" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves luggage allowance for id and version", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "luggage-allowances_update", + "parameters": [ + { + "description": "The id to identify a LuggageAllowance", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the LuggageAllowance", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LuggageAllowance" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing LuggageAllowance", + "tags": [ + "luggage-allowances" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/meta-data": { + "post": { + "operationId": "meta-data_create", + "parameters": [ + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Metadata" + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create metadata", + "tags": [ + "meta-data" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/meta-data/{id}/{version}": { + "get": { + "operationId": "meta-data_getById", + "parameters": [ + { + "description": "The netex id to identify a metadata entry", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version id for the version of the metadata entry", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Metadata" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get metadata for a netexid and version", + "tags": [ + "meta-data" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/parameter-usages/{id}": { + "get": { + "operationId": "parameter-usages_getById", + "parameters": [ + { + "description": "The id to identify a parameter usage mapping ", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves parameter usages for id", + "tags": [ + "parameter-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/penalty-policies": { + "get": { + "operationId": "penalty Policy_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all penaltyPolicy parameters", + "tags": [ + "penalty Policy" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "penalty Policy_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "tags": [ + "penalty Policy" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/penalty-policies/{id}/{version}": { + "delete": { + "operationId": "penalty Policy_deleteById", + "parameters": [ + { + "description": "The id to identify an penalty policy", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the penalty policy", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes an penalty policy by id and version", + "tags": [ + "penalty Policy" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "penalty Policy_getById", + "parameters": [ + { + "description": "The id to identify a PenaltyPolicy", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the PenaltyPolicy", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy for id and version", + "tags": [ + "penalty Policy" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "penalty Policy_update", + "parameters": [ + { + "description": "The id to identify a PenaltyPolicy", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the PenaltyPolicy", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing PenaltyPolicy", + "tags": [ + "penalty Policy" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/penalty-policy-possibilities": { + "post": { + "operationId": "penalty-policy-possibilities_getPenaltyPolicyPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ParameterPossibilitiesRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicyAlternatives" + } + } + } + }, + "description": "Returns the resource." + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy rules for given elements", + "tags": [ + "penalty-policy-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/penalty-policy-possibilities/fare-structure-element/{id}/{version}": { + "get": { + "operationId": "penalty-policy-possibilities_getFSEPenaltyPolicyPossibilities", + "parameters": [ + { + "description": "The id to identify a fare structure element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy rules for given elements", + "tags": [ + "penalty-policy-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/penalty-policy-possibilities/preassigned-product/{id}/{version}": { + "get": { + "operationId": "penalty-policy-possibilities_getFPPenaltyPolicyPossibilities", + "parameters": [ + { + "description": "The id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy rules for given elements", + "tags": [ + "penalty-policy-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/penalty-policy-possibilities/sales-package/{id}/{version}": { + "get": { + "operationId": "penalty-policy-possibilities_getSPPenaltyPolicyPossibilities", + "parameters": [ + { + "description": "The unique id to identify a sales package.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy rules for given elements", + "tags": [ + "penalty-policy-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/penalty-policy-possibilities/validable-element/{id}/{version}": { + "get": { + "operationId": "penalty-policy-possibilities_getVEPenaltyPolicyPossibilities", + "parameters": [ + { + "description": "The id to identify a validable element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves penalty policy rules for given elements", + "tags": [ + "penalty-policy-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/period-tickets": { + "get": { + "operationId": "period-tickets_findPeriodTicketsByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PeriodTicketInfo" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a period tickets and its userprofiles and usage validity periods by authority", + "tags": [ + "period-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/preassigned-products": { + "get": { + "operationId": "preassigned-products_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "the unique id for the language", + "in": "query", + "name": "language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PreassignedFareProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a preassignedFareProduct by organisation id", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "preassigned-products_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreassignedFareProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a PreassignedFareProduct", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/preassigned-products/count": { + "get": { + "operationId": "preassigned-products_getPreassignedFareProductCount", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/preassigned-products/pages": { + "get": { + "operationId": "preassigned-products_findPageByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Number of elements listed in requested page", + "in": "query", + "name": "pageSize", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The given page one want in return", + "in": "query", + "name": "pageNumber", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "the unique id for the language", + "in": "query", + "name": "language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreassignedFareProductPageWrapper" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/preassigned-products/{id}": { + "get": { + "operationId": "preassigned-products_getById", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreassignedFareProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieve the latest version of preassignedFareProduct by id", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/preassigned-products/{id}/refunding": { + "get": { + "operationId": "preassigned-products_getRefundingByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a fareProduct", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "query", + "name": "version", + "required": true, + "schema": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "the unique id for the language", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version of the fareProduct", + "in": "query", + "name": "productVersionId", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Refunding" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives refunding rules by fare product id and version", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/preassigned-products/{id}/{version}": { + "get": { + "operationId": "preassigned-products_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreassignedFareProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of preassignedFareProduct by id and version", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "preassigned-products_update", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreassignedFareProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a preassigned fare product parameter.", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/pricing-parameter-set": { + "get": { + "operationId": "pricing-parameter-set_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PricingParameterSet" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported", + "tags": [ + "pricing-parameter-set" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/product-tree-explanations": { + "get": { + "operationId": "product-tree-explanations_get", + "parameters": [ + { + "description": "The nameOfClass to identify a ProductTreeExplained, i.e \u0027SalesPackage\u0027", + "in": "query", + "name": "nameOfClass", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from BCP-47, e.g. \u0027nb\u0027 or \u0027en\u0027", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductTreeExplained" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all explanations", + "tags": [ + "product-tree-explanations" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/product-tree-explanations/{id}/{version}": { + "get": { + "operationId": "product-tree-explanations_get_1", + "parameters": [ + { + "description": "The netexId to identify a ProductTreeExplained", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The version to identify a ProductTreeExplained", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from BCP-47, e.g. \u0027nb\u0027 or \u0027en\u0027", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductTreeExplained" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves explanation for netexId and version", + "tags": [ + "product-tree-explanations" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/product-usages/{id}": { + "get": { + "operationId": "product-usages_getById", + "parameters": [ + { + "description": "The id to identify a parameter usage mapping ", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves references whe the product with given id is referenced", + "tags": [ + "product-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/purchase-windows": { + "get": { + "operationId": "purchase-windows_getAll", + "parameters": [ + { + "description": "The unique organisation id to identify the owner of the data", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique fareFrame id to identify the owner of the data", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseWindow" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves purchase window by fareFrame id or organisation id", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "purchase-windows_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseWindowInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a purchase window", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/purchase-windows/{id}": { + "get": { + "operationId": "purchase-windows_getById", + "parameters": [ + { + "description": "The unique id to identify a purchase window", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the purchase window", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseWindow" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a purchase window by id", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/purchase-windows/{id}/{version}": { + "get": { + "operationId": "purchase-windows_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a purchase window", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the purchase window", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseWindow" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a purchase window by id and version", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "purchase-windows_update", + "parameters": [ + { + "description": "The unique id to identify a purchase window", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the purchase window", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PurchaseWindowInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a purchase window", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/refunding": { + "get": { + "operationId": "refunding_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refunding" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all refundings", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "refunding_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a refunding rules", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/refunding-possibilities": { + "post": { + "operationId": "refunding-possibilities_getRefundingPossibilities", + "parameters": [ + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ParameterPossibilitiesRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RefundingAlternatives" + } + } + } + }, + "description": "Returns the resource." + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves refunding rules for given elements", + "tags": [ + "refunding-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/refunding-possibilities/preassigned-product/{id}/{version}": { + "get": { + "operationId": "refunding-possibilities_getFPRefundingPossibilities", + "parameters": [ + { + "description": "The unique id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves refunding rules for given elements", + "tags": [ + "refunding-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/refunding-possibilities/sales-package/{id}/{version}": { + "get": { + "operationId": "refunding-possibilities_getSPRefundingPossibilities", + "parameters": [ + { + "description": "The unique id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refunding" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves refunding rules for given elements", + "tags": [ + "refunding-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/refunding-possibilities/validable-element/{id}/{version}": { + "get": { + "operationId": "refunding-possibilities_getVERefundingPossibilities", + "parameters": [ + { + "description": "The unique id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refunding" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves refunding rules for given elements", + "tags": [ + "refunding-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/refunding/{id}": { + "get": { + "operationId": "refunding_getById", + "parameters": [ + { + "description": "The unique id to identify a refunding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the refunding", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Refunding" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a refunding rule by id", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/refunding/{id}/{version}": { + "get": { + "operationId": "refunding_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a refunding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the refunding", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Refunding" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a refunding rule by id and version", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "refunding_update", + "parameters": [ + { + "description": "The unique id to identify a refunding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the refunding", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefundingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a refunding rule", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/replacing": { + "get": { + "operationId": "replacing_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replacing" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all replacings", + "tags": [ + "replacing" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "replacing_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Replacing" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a Replacing", + "tags": [ + "replacing" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/replacing/{id}/{version}": { + "delete": { + "operationId": "replacing_deleteById", + "parameters": [ + { + "description": "The id to identify a Replacing", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Replacing", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Entity deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete an existing replacing", + "tags": [ + "replacing" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "replacing_getByIds", + "parameters": [ + { + "description": "The id to identify a Replacing", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The id for the version of the Replacing", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Replacing" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves replacing for id and version", + "tags": [ + "replacing" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "replacing_update", + "parameters": [ + { + "description": "The id to identify a Replacing", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Replacing", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Replacing" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing Replacing", + "tags": [ + "replacing" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/reserving": { + "get": { + "operationId": "reserving_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reserving" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all reserving rules", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "reserving_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReservingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a reserving rule", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/reserving/{id}": { + "get": { + "operationId": "reserving_getById", + "parameters": [ + { + "description": "The unique ID to identify a reserving.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The ID for the version of the reservation.", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3.", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reserving" + } + } + }, + "description": "Returns the reserving." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a reserving rule by ID.", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/reserving/{id}/{version}": { + "get": { + "operationId": "reserving_getByIdAndVersion", + "parameters": [ + { + "description": "The unique ID to identify a reserving.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The ID for the version of the reservation.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reserving" + } + } + }, + "description": "Returns the reserving." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a reserving rule by id and version.", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "reserving_update", + "parameters": [ + { + "description": "The unique ID to identify a reserving.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The ID for the version of the reservation.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReservingInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a reserving rule", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/reverting": { + "get": { + "operationId": "reverting_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reverting" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all reverting parameters", + "tags": [ + "reverting" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "reverting_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reverting" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a Reverting", + "tags": [ + "reverting" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/reverting/{id}/{version}": { + "get": { + "operationId": "reverting_getById", + "parameters": [ + { + "description": "The id to identify a Reverting", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Reverting", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reverting" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves reverting for id and version", + "tags": [ + "reverting" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "reverting_update", + "parameters": [ + { + "description": "The id to identify a Reverting", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Reverting", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reverting" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing Reverting", + "tags": [ + "reverting" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/round-trips": { + "get": { + "operationId": "round-trips_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all round trips", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "round-trips_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoundTripInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a roundtrip", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/round-trips/{id}": { + "get": { + "operationId": "round-trips_getById", + "parameters": [ + { + "description": "The unique id to identify a roundtrip", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the roundtrip", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoundTrip" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a roundtrip by id", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/round-trips/{id}/{version}": { + "get": { + "operationId": "round-trips_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a roundtrip", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the roundtrip", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoundTrip" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a roundtrip by id and version", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "round-trips_update", + "parameters": [ + { + "description": "The unique id to identify a roundtrip", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the roundtrip", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoundTripInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a round trips", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/roundings": { + "get": { + "operationId": "roundings_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rounding" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all rounding parameters", + "tags": [ + "roundings" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "roundings_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rounding" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a rounding", + "tags": [ + "roundings" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/roundings/{id}/{version}": { + "delete": { + "operationId": "roundings_deleteById", + "parameters": [ + { + "description": "The id to identify a Rounding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Rounding", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a Rounding by id and version", + "tags": [ + "roundings" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "roundings_getById", + "parameters": [ + { + "description": "The id to identify a Rounding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Rounding", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rounding" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves rounding for id and version", + "tags": [ + "roundings" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "roundings_update", + "parameters": [ + { + "description": "The id to identify a Rounding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Rounding", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rounding" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing rounding", + "tags": [ + "roundings" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/sale-discount-rights": { + "get": { + "operationId": "sale-discount-rights_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all sale discount rights", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "sale-discount-rights_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a SaleDiscountRight", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/sale-discount-rights/count": { + "get": { + "operationId": "sale-discount-rights_getCount", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Count" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of sale discount rights", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/sale-discount-rights/entitlement-given/{id}": { + "get": { + "operationId": "sale-discount-rights_getByEntitlementGivenIdWithGpaDataSet", + "parameters": [ + { + "description": "The id to identify an EntitlementGiven", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves sale discount rights by id of the entitlement given they are connected to", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/sale-discount-rights/pages": { + "get": { + "operationId": "sale-discount-rights_getPageWithGpaDataSet", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Size of page", + "in": "query", + "name": "pageSize", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Page number", + "in": "query", + "name": "pageNumber", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaleDiscountRightPageWrapper" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/sale-discount-rights/{id}": { + "get": { + "operationId": "sale-discount-rights_getByIdLatestVersionWithGpaDataSet", + "parameters": [ + { + "description": "The id to identify a SaleDiscountRight", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves newest sale discount right for id", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/sale-discount-rights/{id}/{version}": { + "delete": { + "operationId": "sale-discount-rights_deleteById", + "parameters": [ + { + "description": "The id to identify a SaleDiscountRight", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the SaleDiscountRight", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a SaleDiscountRight by id and version", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "sale-discount-rights_getByIdWithGpaDataSet", + "parameters": [ + { + "description": "The id to identify a SaleDiscountRight", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the SaleDiscountRight", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves sale discount right for id and version", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "sale-discount-rights_update", + "parameters": [ + { + "description": "The id to identify a SaleDiscountRight", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the SaleDiscountRight", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SaleDiscountRight" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing SaleDiscountRight", + "tags": [ + "sale-discount-rights" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/sales-packages": { + "get": { + "operationId": "sales-packages_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fare frame", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesPackage" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves sales packages by organisation id", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "sales-packages_create_1", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesPackageInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a salespackage", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/sales-packages/{id}": { + "get": { + "operationId": "sales-packages_getById", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesPackage" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a sales package by id", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/sales-packages/{id}/{version}": { + "get": { + "operationId": "sales-packages_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesPackage" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a sales package by id", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "sales-packages_update_1", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesPackageInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a sales-package", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/security-policy": { + "get": { + "operationId": "security-policy_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicy" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all security policies", + "tags": [ + "security-policy" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "security-policy_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a SecurityPolicy", + "tags": [ + "security-policy" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/security-policy/defaults": { + "get": { + "operationId": "security-policy_getDefaults", + "parameters": [ + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecurityPolicy" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves default security policies", + "tags": [ + "security-policy" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/security-policy/{id}/{version}": { + "get": { + "operationId": "security-policy_getById", + "parameters": [ + { + "description": "The id to identify a SecurityPolicy", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the SecurityPolicy", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves security policy for id and version", + "tags": [ + "security-policy" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "security-policy_update", + "parameters": [ + { + "description": "The id to identify a SecurityPolicy", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the SecurityPolicy", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityPolicy" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing SecurityPolicy", + "tags": [ + "security-policy" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/service-facility-sets": { + "get": { + "operationId": "service-facility-sets_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceFacilitySet" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all service facility sets", + "tags": [ + "service-facility-sets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "service-facility-sets_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceFacilitySet" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a ServiceFacilitySet", + "tags": [ + "service-facility-sets" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/service-facility-sets/{id}/{version}": { + "delete": { + "operationId": "service-facility-sets_deleteById", + "parameters": [ + { + "description": "The id to identify a ServiceFacilitySet", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ServiceFacilitySet", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a ServiceFacilitySet by id and version", + "tags": [ + "service-facility-sets" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "service-facility-sets_getById", + "parameters": [ + { + "description": "The id to identify a ServiceFacilitySet", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ServiceFacilitySet", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceFacilitySet" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves service facility set for id and version", + "tags": [ + "service-facility-sets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "service-facility-sets_update", + "parameters": [ + { + "description": "The id to identify a ServiceFacilitySet", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ServiceFacilitySet", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceFacilitySet" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing ServiceFacilitySet", + "tags": [ + "service-facility-sets" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/supplement-products": { + "get": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_getAll_1", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to idetify data owned by organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "the unique id for the language", + "in": "query", + "name": "language", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupplementProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a supplement products by organisation id", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_create_1", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplementProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a SupplementProduct", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/supplement-products/{id}": { + "get": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_getById", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplementProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of supplement products by id", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/supplement-products/{id}/refunding": { + "get": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_getRefundingByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a fareProduct", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "the unique id for the language", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version of the fareProduct", + "in": "query", + "name": "productVersionId", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Refunding" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives refunding rules by fare product id and version", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/supplement-products/{id}/{version}": { + "get": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplementProduct" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of supplement product by id and version", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_update_1", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the fare structure element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplementProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a supplement product parameter.", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/tariffs": { + "post": { + "operationId": "tariffs_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TariffInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a tariff", + "tags": [ + "tariffs" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/tariffs/{id}/{version}": { + "get": { + "operationId": "tariffs_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a tariff", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the tariff", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tariff" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a tariff by id", + "tags": [ + "tariffs" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/text-in-language/{id}/{version}": { + "put": { + "operationId": "text-in-language_update", + "parameters": [ + { + "description": "The unique id to identify the entity", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the entity", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NameAndDescription" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity set successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create or update name and description on an entity", + "tags": [ + "text-in-language" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/timebands": { + "get": { + "operationId": "timebands_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Timeband" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all time bands", + "tags": [ + "timebands" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "timebands_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Timeband" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a time band", + "tags": [ + "timebands" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/timebands/{id}/{version}": { + "get": { + "operationId": "timebands_getById", + "parameters": [ + { + "description": "The id to identify a Timeband", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Timeband", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Timeband" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves time band for id and version", + "tags": [ + "timebands" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "timebands_update", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "path", + "name": "version", + "required": true, + "schema": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Timeband" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a time band", + "tags": [ + "timebands" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/transferabilities": { + "get": { + "operationId": "transferabilities_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all transferabilities", + "tags": [ + "transferabilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "transferabilities_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Transferability" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a transferability", + "tags": [ + "transferabilities" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/transferabilities/{id}/{version}": { + "get": { + "operationId": "transferabilities_getById", + "parameters": [ + { + "description": "The id to identify a Transferability", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Transferability", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Transferability" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferabilities for id and version", + "tags": [ + "transferabilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "transferabilities_update", + "parameters": [ + { + "description": "The id to identify a Transferability", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the Transferability", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Transferability" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing Transferability", + "tags": [ + "transferabilities" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/transferability-possibilities": { + "post": { + "operationId": "transferability-possibilities_getTransferabilityPossibilities", + "parameters": [ + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransferabilityAlternatives" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferabilityAlternatives" + } + } + } + }, + "description": "Returns the resource." + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferability rules for given elements", + "tags": [ + "transferability-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/transferability-possibilities/fare-structure-element/{id}/{version}": { + "get": { + "operationId": "transferability-possibilities_getFSETransferabilityPossibilities", + "parameters": [ + { + "description": "The id to identify a fare structure element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferability rules for given elements", + "tags": [ + "transferability-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/transferability-possibilities/preassigned-product/{id}/{version}": { + "get": { + "operationId": "transferability-possibilities_getFPTransferabilityPossibilities", + "parameters": [ + { + "description": "The id to identify a product.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferability rules for given elements", + "tags": [ + "transferability-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/transferability-possibilities/sales-package/{id}/{version}": { + "get": { + "operationId": "transferability-possibilities_getSPTransferabilityPossibilities", + "parameters": [ + { + "description": "The unique id to identify a sales package.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferability rules for given elements", + "tags": [ + "transferability-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/transferability-possibilities/validable-element/{id}/{version}": { + "get": { + "operationId": "transferability-possibilities_getVETransferabilityPossibilities", + "parameters": [ + { + "description": "The id to identify a validable element.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the element.", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code for the name and description fields.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The id of the distribution channel.", + "in": "header", + "name": "Entur-Distribution-Channel", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves transferability rules for given elements", + "tags": [ + "transferability-possibilities" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/type-of-concession": { + "get": { + "operationId": "type-of-concession_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fareframe", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeOfConcession" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves typeOfConcession by fareframe id or organisation id", + "tags": [ + "type-of-concession" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/type-of-concession/{id}": { + "get": { + "operationId": "type-of-concession_getById", + "parameters": [ + { + "description": "The unique id to identify a typeOfConcession", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the typeOfConcession", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfConcession" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a typeOfConcession by id", + "tags": [ + "type-of-concession" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/type-of-concession/{id}/{version}": { + "get": { + "operationId": "type-of-concession_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a typeOfConcession", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the typeOfConcession", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfConcession" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a typeOfConcession by id and version", + "tags": [ + "type-of-concession" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "type-of-concession_update", + "parameters": [ + { + "description": "The unique id to identify a typeOfConcession", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the typeOfConcession", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfConcessionInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a type of concession", + "tags": [ + "type-of-concession" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/type-of-fare-products": { + "get": { + "operationId": "type-of-fare-products_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfFareProduct" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of fare products by organisationId or fareFrameId", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "type-of-fare-products_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfFareProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create type of fare product", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/type-of-fare-products/{id}": { + "get": { + "operationId": "type-of-fare-products_getById", + "parameters": [ + { + "description": "The unique id to identify a type of fare product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfFareProduct" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of fare product by id", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/type-of-fare-products/{id}/{version}": { + "get": { + "operationId": "type-of-fare-products_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a type of fare product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfFareProduct" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of fare product by id", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "type-of-fare-products_update", + "parameters": [ + { + "description": "The unique id to identify a type of fare product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfFareProductInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a type of fare product", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/type-of-responsibility-role": { + "get": { + "operationId": "type-of-responsibility-role_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieve all typeOfResponsibilityRoles", + "tags": [ + "type-of-responsibility-role" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/type-of-usage-parameters": { + "get": { + "operationId": "type-of-usage-parameters_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfUsageParameter" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all type of usage parameters.", + "tags": [ + "type-of-usage-parameters" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "type-of-usage-parameters_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfUsageParameterInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create type of usage parameter ", + "tags": [ + "type-of-usage-parameters" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/type-of-usage-parameters/{id}/{version}": { + "get": { + "operationId": "type-of-usage-parameters_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a type of usage parameters", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "version", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeOfUsageParameter" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of usage parameter by id and version", + "tags": [ + "type-of-usage-parameters" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/usage-validity-periods": { + "get": { + "operationId": "usage-validity-periods_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fare frame", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UsageValidityPeriod" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves usage validity periods by organisation id", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "usage-validity-periods_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsageValidityPeriodInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a usage validity parameter", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/usage-validity-periods/batch": { + "post": { + "operationId": "usage-validity-periods_createMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a list of uvp", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "put": { + "operationId": "usage-validity-periods_updateMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a list of uvps", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/usage-validity-periods/{id}": { + "get": { + "operationId": "usage-validity-periods_getById", + "parameters": [ + { + "description": "The unique id to identify a usage validity period", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the usage validity period", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsageValidityPeriod" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a usage validity period by id", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/usage-validity-periods/{id}/{version}": { + "get": { + "operationId": "usage-validity-periods_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a usage validity period", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the usage validity period", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsageValidityPeriod" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a usage validity period by id", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "usage-validity-periods_update", + "parameters": [ + { + "description": "The unique id to identify a usage validity period", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the usage validity period", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsageValidityPeriodInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a usage validity period", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/user-profiles": { + "get": { + "operationId": "user-profiles_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfile" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all user profile", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "user-profiles_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a userprofile", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/user-profiles/{id}": { + "get": { + "operationId": "user-profiles_getById", + "parameters": [ + { + "description": "The unique id to identify a userprofile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the userprofile", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfile" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a userprofile by id", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/user-profiles/{id}/{version}": { + "get": { + "operationId": "user-profiles_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a userprofile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the userprofile", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfile" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a userprofile by id and version", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "user-profiles_update", + "parameters": [ + { + "description": "The unique id to identify a userprofile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the userprofile", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserProfileInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a user profile", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/uvp-for-number-of-zones": { + "get": { + "operationId": "uvp-for-number-of-zones_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify dataset to an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UVPForNumberOfZones" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "uvp-for-number-of-zones", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "uvp-for-number-of-zones_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a uvpForNumberOfZones", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/uvp-for-number-of-zones/batch": { + "post": { + "operationId": "uvp-for-number-of-zones_createMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a list of uvp for number of zones", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "put": { + "operationId": "uvp-for-number-of-zones_updateMany", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a list of uvpForZones", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/uvp-for-number-of-zones/{id}/{version}": { + "get": { + "operationId": "uvp-for-number-of-zones_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a UVPForNumberOfZones", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the UVPForNumberOfZones", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UVPForNumberOfZones" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a UVPForNumberOfZones by id", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "uvp-for-number-of-zones_update", + "parameters": [ + { + "description": "The unique id to identify a UVPForNumberOfZones", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the UVPForNumberOfZones", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a uvpForNumberOfZones", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v1/charging-moments/{id}": { + "get": { + "operationId": "charging-moment-controller-v-1_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a charging moment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the charging moment", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the charging moments version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the charging moments version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ChargingMoment" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a charging moment by id", + "tags": [ + "charging-moment-controller-v-1" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/companion-profiles/{id}": { + "get": { + "deprecated": true, + "operationId": "companion-profiles_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a companion profile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the companion profile", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the companion profiles version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the companion profiles version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompanionProfile" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a companion profile by id", + "tags": [ + "companion-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/distance-matrix-elements/{id}": { + "get": { + "operationId": "distance-matrix-elements_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a distance matrix elment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the distance matrix elment", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the distance matrix elments version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the distance matrix elments version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DistanceMatrixElement" + } + } + } + }, + "description": "Returns the distance matrix elment" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a distance matrix elment by id", + "tags": [ + "distance-matrix-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/exchanging/{id}": { + "get": { + "operationId": "exchanging_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a exchanging", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the exchanging rule", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the exchanging rules version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the exchanging rules version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "summary": "Retrieves a exchanging rule by id", + "tags": [ + "exchanging" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/fare-frames/{id}": { + "get": { + "operationId": "fare-frames_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a fare frames", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the fare frame", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the fare frames version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the fare frames version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareFrame" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a fare frames by id", + "tags": [ + "fare-frames" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/fare-structure-elements/{id}": { + "get": { + "operationId": "fare-structure-elements_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a fare structure element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the fare structure element", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the fare structure elements version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the fare structure elements version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareStructureElement" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a fare structure element by netexId", + "tags": [ + "fare-structure-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/fare-tables/{id}": { + "get": { + "operationId": "fare-tables_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a fare table", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the fare table", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "if set to true fare table cells will be omitted", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the fare tables version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the fare tables version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FareTable" + } + } + } + }, + "description": "Returns the fare table" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a fare table by id", + "tags": [ + "fare-tables" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/frequencies-of-use/{id}": { + "get": { + "operationId": "frequencies-of-use_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a frequency of use", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the frequency of use", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the frequency of use version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the frequency of use version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FrequencyOfUse" + } + } + } + }, + "description": "Returns the frequencies of use" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves frequencies of use by id", + "tags": [ + "frequencies-of-use" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/generic-parameter-assignments/{id}": { + "get": { + "operationId": "generic-parameter-assignments_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a generic parameter assignment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the generic parameter assignment", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the generic parameter assignments version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the generic parameter assignments version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a generic parameter assignment by id", + "tags": [ + "generic-parameter-assignments" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/geographical-intervals/{id}": { + "get": { + "operationId": "geographical-intervals_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a geographical interval", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the geographical interval", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the geographical intervals version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the geographical intervals version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicalInterval" + } + } + } + }, + "description": "Returns the geographical interval" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a geographical interval by id", + "tags": [ + "geographical-intervals" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/group-tickets/{id}": { + "get": { + "operationId": "group-tickets_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a group ticket", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the group ticket", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the group tickets version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the group tickets version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupTicket" + } + } + } + }, + "description": "Returns the group ticket" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a group ticket by id", + "tags": [ + "group-tickets" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/interchangings/{id}": { + "get": { + "operationId": "interchangings_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a group ticket", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the interchaning", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the interchaning version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the interchaning version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Interchanging" + } + } + } + }, + "description": "Returns interchaning" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves an interchanging by id", + "tags": [ + "interchangings" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/preassigned-products/{id}": { + "get": { + "operationId": "preassigned-products_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the product", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the products version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the products version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PreassignedFareProduct" + } + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of preassignedFareProduct by id", + "tags": [ + "preassigned-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/purchase-windows/{id}": { + "get": { + "operationId": "purchase-windows_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a purchase window", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the purchase window", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the purchase windows version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the purchase windows version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PurchaseWindow" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a purchase window by id", + "tags": [ + "purchase-windows" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/refunding/{id}": { + "get": { + "operationId": "refunding_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a refunding", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the refunding rule", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the refunding rules version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the refunding rules version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Refunding" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a refunding rule by id", + "tags": [ + "refunding" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/reserving/{id}": { + "get": { + "operationId": "reserving_getByIdV2", + "parameters": [ + { + "description": "The unique ID to identify a reserving.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3.", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the reserving rule.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the reserving rule version.", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the reserving rule version.", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reserving" + } + } + } + }, + "description": "Returns the reserving rule." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a reserving rule by ID", + "tags": [ + "reserving" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/round-trips/{id}": { + "get": { + "operationId": "round-trips_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a round trips", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the round trips", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the round trips version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the round tripss version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RoundTrip" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a round trips by id", + "tags": [ + "round-trips" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/sales-packages/{id}": { + "get": { + "operationId": "sales-packages_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the sales package", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the sales packages version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the sales packages version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesPackage" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a sales package by id", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/supplement-products/{id}": { + "get": { + "deprecated": true, + "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", + "operationId": "supplement-products_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the product", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the products version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the products version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupplementProduct" + } + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the latest version of supplement product by id", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/tariffs/{id}": { + "get": { + "operationId": "tariffs_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a tariff", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the tariff", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the tariffs version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the tariffs version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tariff" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a tariff by id", + "tags": [ + "tariffs" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/type-of-concession/{id}": { + "get": { + "operationId": "type-of-concession_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a type of concession", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the type of concession", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the type of concessions version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the type of concessions version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeOfConcession" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives a type of concession by id", + "tags": [ + "type-of-concession" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/type-of-fare-products/{id}": { + "get": { + "operationId": "type-of-fare-products_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a type of fare product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the type of fare product", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the type of fare products version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the type of fare products version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeOfFareProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of fare product by id", + "tags": [ + "type-of-fare-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/type-of-usage-parameters/{id}": { + "get": { + "operationId": "type-of-usage-parameters_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a type of usage parameters", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the type of usage parameters", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the type of usage parameters version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the type of usage parameter version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeOfUsageParameter" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves type of usage parameter by id", + "tags": [ + "type-of-usage-parameters" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/usage-validity-periods/{id}": { + "get": { + "operationId": "usage-validity-periods_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a usage validity period", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the usage validity period", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the usage validity periods version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the usage validity periods version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UsageValidityPeriod" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a usage validity period by id", + "tags": [ + "usage-validity-periods" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/user-profiles/{id}": { + "get": { + "operationId": "user-profiles_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a user profile", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the user profile", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the user profiles version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the user profiles version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserProfile" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a user profile by id", + "tags": [ + "user-profiles" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/uvp-for-number-of-zones/{id}": { + "get": { + "operationId": "uvp-for-number-of-zones_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a charging moment", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the charging moment", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the charging moments version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the charging moments version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UVPForNumberOfZones" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a uvpForNumberOfZones by id", + "tags": [ + "uvp-for-number-of-zones" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/valid-betweens/{id}": { + "get": { + "deprecated": true, + "operationId": "valid-betweens_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a validBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "Languagecode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the validBetween", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the validBetween version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the validBetween version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidBetween" + } + } + } + }, + "description": "Returns the valid between" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrives valid betweens by id for a given date. This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v1/validable-elements/{id}": { + "get": { + "operationId": "validable-elements_getByIdV2", + "parameters": [ + { + "description": "The unique id to identify a validable element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "startDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "endDate", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The version status of the validable element", + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The from date of the validable elements version", + "in": "query", + "name": "fromDate", + "schema": { + "type": "string" + } + }, + { + "description": "The to date of the validable elements version", + "in": "query", + "name": "toDate", + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidableElement" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable elements by id and latest version", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v2/sales-packages": { + "get": { + "operationId": "sales-packages_getAllWithGpaDataSetAndStatusFilter", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v2.SalesPackage" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all sales packages", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "sales-packages_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SalesPackage" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a sales package", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v2/sales-packages/count": { + "get": { + "operationId": "sales-packages_count", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + }, + "description": "Returns the number of sales packages" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of sales packages", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v2/sales-packages/pages": { + "get": { + "operationId": "sales-packages_pages", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The number of sales packages per page", + "in": "query", + "name": "pageSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The page number", + "in": "query", + "name": "pageNumber", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesPackagePageWrapper" + } + } + }, + "description": "Returns the number of pages of sales packages" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of pages of sales packages", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v2/sales-packages/{id}/{version}": { + "delete": { + "operationId": "sales-packages_deleteById", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the sales package", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Entity deleted successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Delete a sales package given id and version", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "sales-packages_getByIdWithGpaDataSet", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the sales package", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SalesPackage" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves sales package given id and version", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "sales-packages_update", + "parameters": [ + { + "description": "The unique id to identify a sales package", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The version of the sales package", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SalesPackage" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing sales package", + "tags": [ + "sales-packages" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v2/supplement-products": { + "get": { + "operationId": "supplement-products_getAll", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Possibility of opting out of including child elements", + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all supplement products", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "supplement-products_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + }, + "description": "Returns the created supplement product" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Creates a new supplement product", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v2/supplement-products/{id}/versions": { + "get": { + "operationId": "supplement-products_getVersionsOrActiveById", + "parameters": [ + { + "description": "The id to identify a supplement product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", + "in": "query", + "name": "active", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all versions of a supplement product", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v2/supplement-products/{id}/{version}": { + "get": { + "operationId": "supplement-products_getByIdWithGpaDataSet", + "parameters": [ + { + "description": "The id to identify a supplement product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the supplement product", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + }, + "description": "Returns the supplement product" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves a supplement product by id and version", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "supplement-products_update", + "parameters": [ + { + "description": "The id to identify a supplement product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the supplement product", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/v2.SupplementProduct" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing supplement product", + "tags": [ + "supplement-products" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v2/valid-betweens": { + "get": { + "operationId": "valid-betweens_getAll_1", + "parameters": [ + { + "description": "The unique id to identify an organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "minimizeDataLoad", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidBetween" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all valid betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "valid-betweens_create_1", + "parameters": [ + { + "in": "header", + "name": "X-Correlated-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetween" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a validBetween", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/v2/valid-betweens/{id}": { + "get": { + "operationId": "valid-betweens_getById_1", + "parameters": [ + { + "description": "The id to identify a ValidBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetween" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves active valid between for id", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/v2/valid-betweens/{id}/{version}": { + "delete": { + "operationId": "valid-betweens_deleteById_1", + "parameters": [ + { + "description": "The id to identify a ValidBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ValidBetween", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlated-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoxedUnit" + } + } + }, + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a valid between by id and version", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "operationId": "valid-betweens_getById", + "parameters": [ + { + "description": "The id to identify a ValidBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ValidBetween", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetween" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves valid between for id and version", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "valid-betweens_update_1", + "parameters": [ + { + "description": "The id to identify a ValidBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ValidBetween", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlated-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetween" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Updates an existing ValidBetween", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/valid-betweens": { + "get": { + "deprecated": true, + "operationId": "valid-betweens_getAll", + "parameters": [ + { + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset for an organization", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PenaltyPolicyAlternatives" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all valid betweens for a given fare frame. This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "deprecated": true, + "operationId": "valid-betweens_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetweenInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a validBetween. This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/valid-betweens/{id}/{version}": { + "delete": { + "deprecated": true, + "operationId": "valid-betweens_deleteById", + "parameters": [ + { + "description": "The id to identify a ValidBetween", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id for the version of the ValidBetween", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The resource was deleted" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Deletes a ValidBetween by id and version. This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + }, + "get": { + "deprecated": true, + "operationId": "valid-betweens_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a validable element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the given validable element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "header", + "name": "Accept-Language", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetween" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable between by id and version. This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "deprecated": true, + "operationId": "valid-betweens_update", + "parameters": [ + { + "description": "The unique id to identify the valid between", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the valid between", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidBetweenInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a valid between. . This api is deprecated, use .../v2/valid-betweens", + "tags": [ + "valid-betweens" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/validable-elements": { + "get": { + "operationId": "validable-elements_getAll", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fare frame", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidableElement" + } + } + } + }, + "description": "Returns the resources" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable elements by organisation id or fareframe", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "post": { + "operationId": "validable-elements_create", + "parameters": [ + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidableElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Already registered" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create a validable-element", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/validable-elements-usages/{id}": { + "get": { + "operationId": "validable-elements-usages_getById", + "parameters": [ + { + "description": "The netex_id to identify a validable element ", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ElementUsages" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves references where the given validable element id is referenced", + "tags": [ + "validable-elements-usages" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/validable-elements/count": { + "get": { + "operationId": "validable-elements_getCount", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fare frame", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int32" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/validable-elements/pages": { + "get": { + "operationId": "validable-elements_findPagesByOrganisationIdOrFareFrameId", + "parameters": [ + { + "description": "The unique id to identify a organisation", + "in": "query", + "name": "orgId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a fare frame", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The number of elements to return", + "in": "query", + "name": "pageSize", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "The offset to start from", + "in": "query", + "name": "pageNumber", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", + "example": [ + "DRAFT", + "PROPOSED" + ], + "in": "query", + "name": "statusFilter", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidableElementPageWrapper" + } + } + }, + "description": "Returns the resources" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable elements by organisation id or fareframe", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/validable-elements/{id}": { + "get": { + "operationId": "validable-elements_getById", + "parameters": [ + { + "description": "The unique id to identify a validable element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the given validable element", + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidableElement" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable elements by id and latest version", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/validable-elements/{id}/{version}": { + "get": { + "operationId": "validable-elements_getByIdAndVersion", + "parameters": [ + { + "description": "The unique id to identify a validable element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the given validable element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Type of gpa dataset", + "in": "query", + "name": "gpaDataSet", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidableElement" + } + } + }, + "description": "Returns the resource" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves validable elements by id and version", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "validable-elements_update", + "parameters": [ + { + "description": "The unique id to identify a validable element", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The id of the version of the given validable element", + "in": "path", + "name": "version", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidableElementInsert" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Update a validable element", + "tags": [ + "validable-elements" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/vat-register": { + "get": { + "operationId": "vat-register_getAllVatRegisters", + "parameters": [ + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VatRegister" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves all vat registers", + "tags": [ + "vat-register" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/vat-register/{vatGroup}": { + "get": { + "operationId": "vat-register_getVatRegisters", + "parameters": [ + { + "description": "The identifier for a VAT", + "in": "path", + "name": "vatGroup", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VatRegister" + } + } + } + }, + "description": "Returns the resource." + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found." + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves vat register for group", + "tags": [ + "vat-register" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/versions": { + "post": { + "operationId": "versions_create", + "parameters": [ + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Version" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Entity created successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Not Found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Create version", + "tags": [ + "versions" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + }, + "/versions/batch": { + "post": { + "operationId": "versions_getVersionsByObjectIds", + "parameters": [ + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VersionBatchRetrieve" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Version" + } + } + } + }, + "description": "Returns the info" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get all versions", + "tags": [ + "versions" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/versions/element-type/{nameOfClass}": { + "get": { + "operationId": "versions_getMinimalVersionInfoByClassOfName", + "parameters": [ + { + "description": "The unique class name to identify for an elementType", + "in": "path", + "name": "nameOfClass", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a dataset to an organisation", + "in": "query", + "name": "fareFrameId", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MininmalVersionInfo" + } + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Retrieves metadata of specific element type by class name", + "tags": [ + "versions" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + } + }, + "/versions/{id}": { + "get": { + "operationId": "versions_getById", + "parameters": [ + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The netex id to identify a version entry", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + }, + { + "description": "The language code from ISO-639-3", + "in": "query", + "name": "languageCode", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", + "in": "header", + "name": "If-None-Match", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Version" + } + } + }, + "description": "Returns the info" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Get version for netexid", + "tags": [ + "versions" + ], + "x-entur-permissions": { + "value": "product-api-access:les" + } + }, + "put": { + "operationId": "versions_updateVersionStatus", + "parameters": [ + { + "in": "header", + "name": "Et-Client-Name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Correlation-Id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The unique id to identify a version of a product", + "in": "path", + "name": "id", + "required": true, + "schema": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Version" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Entity updated successfully" + }, + "400": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Validation errors" + }, + "401": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Missing Authorization" + }, + "403": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Authorization failed" + }, + "404": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Resource not found" + }, + "409": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Conflict" + }, + "500": { + "content": { + "application/problem+json": { + "schema": { + "type": "string" + } + } + }, + "description": "Internal server error" + } + }, + "security": [ + { + "basic_auth": [] + } + ], + "summary": "Set the status of a product version by id", + "tags": [ + "versions" + ], + "x-entur-permissions": { + "value": "product-api-access:endre" + } + } + } + }, + "components": { + "schemas": { + "AccessRightInProduct": { + "required": [ + "fareFrameRef", + "id", + "preassignedFareProductRef", + "validableElementRef", + "version" + ], + "type": "object", + "properties": { + "accessNumber": { + "type": "integer", + "description": "The actual access number", + "format": "int32" + }, + "accessNumberIsLimited": { + "type": "boolean", + "description": "Flag indicating if access number is limited" + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:AccessRightInProduct:Ordinary" + }, + "isFirstInSequence": { + "type": "boolean", + "description": "Whether element is first in sequence" + }, + "isLastInSequence": { + "type": "boolean", + "description": "Whether element is last in sequence" + }, + "limitedAccessNumber": { + "type": "integer", + "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", + "format": "int32" + }, + "maximumAccess": { + "type": "integer", + "description": "Maximum number of times use of this element may occur in a given trip", + "format": "int32" + }, + "minimumAccess": { + "type": "integer", + "description": "Minimum number of times use of this element must occur in a given trip", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "Refunding" + }, + "orderOfElement": { + "type": "integer", + "description": "The actual order in the sequence", + "format": "int32" + }, + "preassignedFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Access right in product status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Access right in product version.", + "example": "NSB:Version:V1" + } + }, + "description": "A VALIDABLE ELEMENT as a part of a PRE-ASSIGNED FARE PRODUCT, including its possible order in the set of all VALIDABLE ELEMENTs grouped together to define the access right assigned to that PRE-ASSIGNED FARE PRODUCT." + }, + "AccessRightInProductInsert": { + "required": [ + "fareFrameRef", + "id", + "preassignedFareProductRef", + "validableElementRef" + ], + "type": "object", + "properties": { + "accessNumber": { + "type": "integer", + "description": "The actual access number", + "format": "int32" + }, + "accessNumberIsLimited": { + "type": "boolean", + "description": "Flag indicating if access number is limited" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:AccessRightInProduct:Ordinary" + }, + "isFirstInSequence": { + "type": "boolean", + "description": "Whether element is first in sequence" + }, + "isLastInSequence": { + "type": "boolean", + "description": "Whether element is last in sequence" + }, + "maximumAccess": { + "type": "integer", + "description": "Maximum number of times use of this element may occur in a given trip", + "format": "int32" + }, + "minimumAccess": { + "type": "integer", + "description": "Minimum number of times use of this element must occur in a given trip", + "format": "int32" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "orderOfElement": { + "type": "integer", + "description": "The actual order in the sequence", + "format": "int32" + }, + "preassignedFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + } + }, + "Accommodation": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "accommodationFacility": { + "type": "string", + "description": "Accommodation facility.", + "example": "SLEEPER", + "enum": [ + "SLEEPER", + "SEATING", + "DOUBLE_SLEEPER", + "SINGLE_SLEEPER", + "SPECIAL_SLEEPER", + "COUCHETTE", + "SINGLE_COUCHETTE", + "DOUBLE_COUCHETTE", + "RECLINING_SEAT", + "BABY_COMPARTMENT", + "FAMILY_COMPARTMENT", + "PANORAMA_COACH", + "PULLMAN_COACH", + "STANDING" + ] + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Accommodation:Sleeper" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "Accommodation" + }, + "nuisanceFacilities": { + "type": "array", + "description": "List of nuisance facilities", + "items": { + "type": "string" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "An Accommodation" + }, + "AmountOfPriceUnitProduct": { + "required": [ + "amount", + "chargingMoment", + "chargingMomentRef", + "fareFrameRef", + "id", + "modification", + "productType", + "status" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "AccessRightParameterAssignmentRefs.", + "writeOnly": true, + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "accessRightParameterAssignments": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "amount": { + "minimum": 1, + "type": "integer", + "description": "Amount. Must be greater than 0.", + "format": "int32", + "example": 10 + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef", + "readOnly": true + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:AmountOfPriceUnitProduct:RuterCarnetTicket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "AmountOfPriceUnitProduct" + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "productType": { + "type": "string", + "description": "AmountOfPriceUnitProductType.", + "example": "TRIP_CARNET", + "enum": [ + "TRIP_CARNET", + "PASS_CARNET", + "UNIT_COUPON", + "STORED_VALUE", + "OTHER" + ] + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "An Amount Of Price Unit Product response" + }, + "AreaValidity": { + "required": [ + "changed", + "created", + "id", + "minimumZonesForAreaValidity", + "modification", + "nameOfClass", + "status", + "typeOfAreaValidity", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "groupOfTariffZoneRef": { + "type": "string", + "description": "Group of tariff zone", + "example": "ENT:GroupOfTariffZone:abcdef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:AreaValidity:RuterSingleTicket" + }, + "minimumZonesForAreaValidity": { + "type": "integer", + "description": "Minimum no. of zones for area validity.", + "format": "int32", + "example": 5 + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "AreaValidity" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfAreaValidity": { + "type": "string", + "description": "Type of area validity", + "example": "RING", + "deprecated": true, + "enum": [ + "POINT_TO_POINT", + "RING" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "readOnly": true, + "example": "RUT:Version:V1" + } + }, + "description": "Requirements for area validity." + }, + "AvailabilityCondition": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fromDate", + "id", + "isAvailable", + "modification", + "nameOfClass", + "status", + "toDate", + "version" + ], + "type": "object", + "properties": { + "available": { + "type": "boolean" + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "dayTypeRefs": { + "type": "array", + "description": "Day Type references.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fromDate": { + "type": "string", + "description": "FromDate datetime." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:AvailabilityCondition:SomeId" + }, + "isAvailable": { + "type": "boolean", + "description": "Is available" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "AvailabilityCondition" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "timebandRefs": { + "type": "array", + "description": "Time band references.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "toDate": { + "type": "string", + "description": "toDate datetime." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "AvailabilityCondition version.", + "example": "ENT:Version:SomeVersion" + } + }, + "description": "An AvailabilityCondition" + }, + "BoxedUnit": { + "type": "object" + }, + "CappedDiscountRight": { + "required": [ + "changed", + "chargingMoment", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "validityConditions", + "vatGroupRegister", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "cappingRules": { + "type": "array", + "description": "Capping rules.", + "items": { + "$ref": "#/components/schemas/CappingRule" + } + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:CappedDiscountRight:BestePrisFylket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "CappedDiscountRight" + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validationRequirements": { + "type": "string", + "description": "An optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", + "example": "[\"IDENTIFIABLE_CUSTOMER\"]" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister.", + "example": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A Capped Discount Right response" + }, + "CappedDiscountRightInsert": { + "required": [ + "chargingMomentRef", + "fareFrameRef", + "id", + "name", + "operatorRef", + "organisation", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProductInsert" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "cappingRules": { + "type": "array", + "description": "Capping rules.", + "items": { + "$ref": "#/components/schemas/CappingRuleInsert" + } + }, + "chargingMomentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummaryInsert" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:CappedDiscountRight:BestePrisFylket" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Organisation." + }, + "prices": { + "type": "array", + "description": "Prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "typeOfFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validationRequirements": { + "type": "string", + "description": "A set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", + "example": "[\"IDENTIFIABLE_CUSTOMER\"]" + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister.", + "default": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "CappingRule": { + "required": [ + "activeComparisonOperatorVariant", + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "Access Right Parameter assignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether a gpa belongs to A or E gpa implementation.", + "example": "A" + }, + "cappingPeriod": { + "type": "string", + "description": "Period over which capping applies.", + "example": "DAY", + "enum": [ + "DAY", + "WEEK", + "MONTH" + ] + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "Reference to fare table.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:CappingRule:EnkeltbillettTil24Timer" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "CappingRule" + }, + "preassignedFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "prices": { + "type": "array", + "description": "Prices for the fare.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "CappingRuleInsert": { + "required": [ + "accessRightParameterAssignmentRefs", + "activeComparisonOperatorVariant", + "fareFrameRef", + "fareTableRefs", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "Access Right Parameter assignment references.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether a gpa belongs to A or E gpa implementation.", + "example": "A" + }, + "cappingPeriod": { + "type": "string", + "description": "Period over which capping applies.", + "example": "DAY", + "enum": [ + "DAY", + "WEEK", + "MONTH" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:CappingRule:EnkeltbillettTil24Timer" + }, + "name": { + "type": "array", + "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "preassignedFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "Cell": { + "required": [ + "changed", + "created", + "farePrice", + "id", + "modification", + "nameOfClass", + "priceableObjectRefs", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "channelGroupRef": { + "type": "object", + "description": "Channel group reference" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "farePrice": { + "$ref": "#/components/schemas/FarePrice" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:Cell:5zoneAdult" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Cell" + }, + "priceableObjectRefs": { + "type": "array", + "description": "References to for example geographical interval and UserProfile", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "CellInsert": { + "required": [ + "fareFrameRef", + "farePrice", + "id", + "name" + ], + "type": "object", + "properties": { + "channelGroupRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "farePrice": { + "$ref": "#/components/schemas/FarePriceInsert" + }, + "fareTableRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:Cell:5zoneAdult" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "priceableObjectRefs": { + "type": "array", + "description": "References to for example geographical interval and UserProfile", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "version": { + "type": "string" + } + } + }, + "ChargingMoment": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ChargingMoment:Prepaid" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "ChargingMoment" + }, + "status": { + "type": "string", + "description": "Charging moment status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Charging moment version.", + "example": "NSB:Version:V1" + } + }, + "description": "A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.", + "readOnly": true, + "deprecated": true + }, + "ChargingMomentInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ChargingMoment:Prepaid" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "version": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Charging moment version.", + "example": "NSB:Version:V1" + } + } + }, + "ChargingPolicy": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "billingPolicy": { + "type": "string", + "description": "TravelBillingPolicy is optional. No default value", + "enum": [ + "BILL_AS_YOU_GO", + "BILL_ON_THRESHOLD", + "BILL_AT_FARE_DAY_END", + "BILL_AT_PERIOD_END" + ] + }, + "changed": { + "type": "string", + "description": "ChargingPolicy changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "ChargingPolicy create datetime.", + "readOnly": true + }, + "creditPolicy": { + "type": "string", + "description": "Travel credit policy enum is optional. No default value", + "enum": [ + "ALLOW_TRAVEL", + "BLOCK_PAY_AS_YOU_GO_TRAVEL", + "BLOCK_ALL_TRAVEL", + "OTHER" + ] + }, + "description": { + "type": "array", + "description": "ChargingPolicy description in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "expireAfterPeriod": { + "type": "string", + "description": "Expire after period. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ChargingPolicy:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "ChargingPolicy name in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "ChargingPolicy" + }, + "paymentGracePeriod": { + "type": "string", + "description": "Payment grace period. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "type of UsageParameter." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A ChargingPolicy response" + }, + "CompanionProfile": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "discountBasis": { + "type": "string", + "description": "Basis for discount.", + "example": "DISCOUNT", + "enum": [ + "NONE", + "FREE", + "DISCOUNT", + "FULLRATE" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the companion profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "generalGroupOfEntities": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:CompanionProfile:Adult" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "maximumNumberOfPersons": { + "type": "integer", + "description": "Maximum number of allowed companions.", + "format": "int32" + }, + "minimumNumberOfPersons": { + "type": "integer", + "description": "Minimum number of allowed companions.", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "CompanionProfile" + }, + "parentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "prices": { + "type": "array", + "description": "Fare prices for the companion profile.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "ticketing": { + "type": "string", + "description": "The type of way that tickets are issued to the group.", + "example": "SEPARATE_TICKETS", + "deprecated": true, + "enum": [ + "ALL_ON_ONE_TICKET", + "SEPARATE_TICKETS", + "TICKET_WITH_COUPONS", + "OTHER" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "userProfileId": { + "type": "string", + "description": "A user profile defining a category of people eligible to be a companion." + }, + "userProfileRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the companion profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "The version of the companion profile.", + "example": "NSB:Version:V1" + } + }, + "description": "A companion profile" + }, + "CompanionProfileInject": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "discountBasis": { + "type": "string", + "description": "Basis for discount.", + "example": "DISCOUNT", + "enum": [ + "NONE", + "FREE", + "DISCOUNT", + "FULLRATE" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "generalGroupOfEntities": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:CompanionProfile:Adult" + }, + "maximumNumberOfPersons": { + "type": "integer", + "description": "Maximum number of allowed companions.", + "format": "int32" + }, + "minimumNumberOfPersons": { + "type": "integer", + "description": "Minimum number of allowed companions.", + "format": "int32" + }, + "name": { + "type": "array", + "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "parentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "prices": { + "type": "array", + "description": "Fare prices for the companion profile.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "ticketing": { + "type": "string", + "description": "The type of way that tickets are issued to the group.", + "example": "SEPARATE_TICKETS", + "deprecated": true, + "enum": [ + "ALL_ON_ONE_TICKET", + "SEPARATE_TICKETS", + "TICKET_WITH_COUPONS", + "OTHER" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "userProfileId": { + "type": "string", + "description": "A user profile defining a category of people eligible to be a companion." + }, + "userProfileRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "The version of the companion profile.", + "example": "NSB:Version:V1" + } + }, + "description": "A companion profile create request" + }, + "ConditionSummary": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ConditionSummary:1005TEN" + }, + "isExchangeable": { + "type": "boolean", + "description": "Whether the ticket is exchangeable.", + "example": true + }, + "isRefundable": { + "type": "boolean", + "description": "Whether the ticket is refundable.", + "example": true + } + }, + "description": "A summary of a condition." + }, + "ConditionSummaryInsert": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ConditionSummary:1005TEN" + }, + "isExchangeable": { + "type": "boolean", + "description": "Whether the ticket is exchangeable.", + "example": true + }, + "isRefundable": { + "type": "boolean", + "description": "Whether the ticket is refundable.", + "example": true + } + }, + "description": "ConditionSummary." + }, + "Count": { + "required": [ + "numberOfElements" + ], + "type": "object", + "properties": { + "numberOfElements": { + "type": "integer", + "description": "number of elements", + "format": "int32", + "example": 369 + } + }, + "description": "Count" + }, + "DayType": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "dayLength": { + "type": "string", + "description": "Day length. Represented as a string formatted according to ISO-8601", + "example": "PT04H" + }, + "description": { + "type": "array", + "description": "Description of day type", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "durationAfterPropertiesOfDay": { + "type": "string", + "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", + "example": "PT7H" + }, + "durationBeforePropertiesOfDay": { + "type": "string", + "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", + "example": "PT24H" + }, + "earliestTime": { + "type": "string", + "description": "Earliest time.", + "example": "11:11:11" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:DayType:BicycleFlatFare" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name of day type", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "DayType" + }, + "properties": { + "type": "array", + "description": "Properties of day", + "items": { + "$ref": "#/components/schemas/PropertyOfDay" + } + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "timebandRefs": { + "type": "array", + "description": "Time band references.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "The DayType describe during which the assignment applies" + }, + "DistanceMatrixElement": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "nameOfClass", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distance": { + "type": "number", + "description": "Distance.", + "format": "double", + "example": 16.4 + }, + "endFareZoneRef": { + "type": "string", + "description": "End fare zone reference." + }, + "endScheduledStopPointId": { + "type": "string", + "description": "End scheduled stop point netexId." + }, + "endTariffZoneId": { + "type": "string", + "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef.", + "deprecated": true + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the user profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "groupId": { + "type": "integer", + "description": "Group id.", + "format": "int64", + "example": 4 + }, + "groupRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:DistanceMatrixElement:NSR167ToNSR359" + }, + "inverseAllowed": { + "type": "boolean", + "description": "Inverse is allowed.", + "example": true + }, + "isDirect": { + "type": "boolean", + "description": "Is a direct route.", + "example": true + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "name": { + "type": "array", + "description": "DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "DistanceMatrixElement" + }, + "prices": { + "type": "array", + "description": "Fare prices for the user profile.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "relativeRanking": { + "type": "integer", + "description": "Relative ranking.", + "format": "int32", + "example": 2 + }, + "startFareZoneRef": { + "type": "string", + "description": "Start fare zone reference." + }, + "startScheduledStopPointId": { + "type": "string", + "description": "Start scheduled stop point netexId." + }, + "startTariffZoneId": { + "type": "string", + "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef.", + "deprecated": true + }, + "tariffId": { + "type": "integer", + "description": "Tariff id.", + "format": "int64" + }, + "tariffRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "DistanceMatrixElement version.", + "example": "NSB:Version:V1" + } + }, + "description": "A DistanceMatrixElement" + }, + "DistanceMatrixElementInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distance": { + "type": "number", + "description": "Distance.", + "format": "double", + "example": 16.4 + }, + "endFareZoneRef": { + "type": "string", + "description": "End fare zone reference." + }, + "endScheduledStopPointId": { + "type": "string", + "description": "End scheduled stop point netexId." + }, + "endTariffZoneId": { + "type": "string", + "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef", + "deprecated": true + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the user profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "groupRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:DistanceMatrixElement:NSR167ToNSR359" + }, + "inverseAllowed": { + "type": "boolean", + "description": "Inverse is allowed.", + "example": true + }, + "isDirect": { + "type": "boolean", + "description": "Is a direct route.", + "example": true + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "name": { + "type": "array", + "description": "DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices for the user profile.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "relativeRanking": { + "type": "integer", + "description": "Relative ranking.", + "format": "int32", + "example": 2 + }, + "startFareZoneRef": { + "type": "string", + "description": "Start fare zone reference." + }, + "startScheduledStopPointId": { + "type": "string", + "description": "Start scheduled stop point netexId." + }, + "startTariffZoneId": { + "type": "string", + "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef", + "deprecated": true + }, + "tariffRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "DistanceMatrixElement version.", + "example": "NSB:Version:V1" + } + }, + "description": "A DistanceMatrixElement create request " + }, + "DistributionAssignment": { + "required": [ + "allDistributionChannelsRef", + "changed", + "created", + "distributionRights", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "organisationRef", + "paymentMethods", + "salesPackageRef", + "status", + "version" + ], + "type": "object", + "properties": { + "allDistributionChannelsRef": { + "type": "boolean", + "description": "Flag for distribution in all channels." + }, + "allOrganisationRef": { + "type": "boolean", + "description": "Flag for all organisations." + }, + "allowedInChannel": { + "type": "boolean", + "description": "Flag for allowed in channel." + }, + "allowedInCountry": { + "type": "boolean", + "description": "Flag for allowed in country." + }, + "anyCountryRef": { + "type": "boolean", + "description": "Flag for allowed in any country." + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef." + }, + "countryRef": { + "type": "string", + "description": "Country reference." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionChannelRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "distributionChannelType": { + "type": "string", + "description": "Type of distribution channel.", + "enum": [ + "AT_STOP", + "ON_BOARD", + "ONLINE", + "TELEPHONE", + "ELECTRONIC_PASS", + "MOBILE_DEVICE", + "AGENCY", + "TOUR_OPERATOR", + "OTHER" + ] + }, + "distributionRights": { + "type": "string", + "description": "Distribution rights.", + "example": "SELL", + "enum": [ + "NONE", + "SELL", + "REFUND", + "EXCHANGE", + "INFROM", + "PRIVATE", + "OTHER" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "finalCarrier": { + "type": "boolean", + "description": "Flag for final carrier." + }, + "fulfilmentMethodRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfDistributionChannelsRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfSalesPackagesRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:DistributionAssignment:Ordinary" + }, + "initialCarrier": { + "type": "boolean", + "description": "Flag for initial carrier." + }, + "mandatoryProduct": { + "type": "boolean", + "description": "Flag for mandatory product." + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "DistributionAssignment" + }, + "organisationRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "paymentMethods": { + "type": "array", + "description": "Payment methods.", + "items": { + "type": "string" + } + }, + "requiresRegistration": { + "type": "boolean", + "description": "Flag for requires registration." + }, + "responsibilitySetRef": { + "type": "string", + "description": "Responsibility set reference." + }, + "restrictedToChannel": { + "type": "boolean", + "description": "Flag for restricted to channel." + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "serviceAccessRightRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "ticketingServices": { + "type": "array", + "description": "Ticketing services.", + "items": { + "type": "string" + } + }, + "topographicPlaceRef": { + "type": "string", + "description": "Topographical place reference." + }, + "transitCarrier": { + "type": "boolean", + "description": "Flag for transit carrier." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A distributionAssignment" + }, + "DistributionAssignmentInsert": { + "required": [ + "allDistributionChannelsRef", + "distributionRights", + "fareFrameRef", + "id", + "name", + "organisationRef", + "salesPackageRef", + "version" + ], + "type": "object", + "properties": { + "allDistributionChannelsRef": { + "type": "boolean", + "description": "Flag for distribution in all channels." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionChannelRef": { + "type": "string", + "description": "Distribution channel Ref." + }, + "distributionRights": { + "type": "string", + "description": "Distribution rights.", + "example": "SELL", + "enum": [ + "NONE", + "SELL", + "REFUND", + "EXCHANGE", + "INFROM", + "PRIVATE", + "OTHER" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fulfilmentMethodRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfDistributionChannelsRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:DistributionAssignment:Ordinary" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "organisationRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "paymentMethods": { + "type": "array", + "description": "Payment methods.", + "items": { + "type": "string" + } + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "ElementUsages": { + "type": "object", + "properties": { + "elementRefs": { + "type": "array", + "description": "Parameters usages mapped to the requested parameter.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + } + }, + "description": "ParameterUsages" + }, + "EntitlementConstraint": { + "required": [ + "nameOfClass" + ], + "type": "object", + "properties": { + "classOfUseConstraint": { + "type": "string", + "description": "Class of use constraint", + "enum": [ + "ANY", + "SAME", + "SAME_OR_EQUIVALENT", + "DIFFERENT" + ] + }, + "destinationConstraint": { + "type": "string", + "description": "Destination constraint", + "enum": [ + "ANY", + "SAME", + "SAME_AS_ORIGIN", + "SAME_AS_DESTINATION", + "SAME_AS_ORIGIN_OR_DESTINATION", + "ANY_STOP_ON_ROUTE", + "ANY_STOP_IN_ZONE", + "DIFFERENT" + ] + }, + "directionConstraint": { + "type": "string", + "description": "Direction constraint", + "enum": [ + "ANY", + "SAME", + "OPPOSITE_DIRECTION", + "DIFFERENT" + ] + }, + "fareScheduledStopPoints": { + "type": "array", + "description": "Fare scheduled stop points which entitlement applies", + "items": { + "$ref": "#/components/schemas/FareScheduledStopPoint" + } + }, + "journeyConstraint": { + "type": "string", + "description": "Journey constraint", + "enum": [ + "ANY", + "SAME", + "SIMILAR", + "DIFFERENT" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "EntitlementConstraint" + }, + "operatorConstraint": { + "type": "string", + "description": "Operator constraint", + "enum": [ + "ANY", + "SAME", + "PARTICIPATING", + "DIFFERENT" + ] + }, + "originConstraint": { + "type": "string", + "description": "Origin constraint", + "enum": [ + "ANY", + "SAME", + "SAME_AS_ORIGIN", + "SAME_AS_DESTINATION", + "SAME_AS_ORIGIN_OR_DESTINATION", + "ANY_STOP_ON_ROUTE", + "ANY_STOP_IN_ZONE", + "DIFFERENT" + ] + }, + "periodConstraint": { + "type": "string", + "description": "Period constraint", + "enum": [ + "ANY", + "SAME_PERIOD", + "WITHIN_SAME_PERIOD", + "SAME_DAY", + "SAME_DAY_OF_RETURN", + "SAME_FARE_DAY", + "NEXT_DAY", + "EQUIVALENT_DURATION", + "DIFFERENT" + ] + }, + "routeConstraint": { + "type": "string", + "description": "Route constraint", + "enum": [ + "ANY", + "SAME", + "OPPOSITE_DIRECTION", + "DIFFERENT" + ] + }, + "specificProfiles": { + "type": "array", + "description": "Specific user profiles which entitlement applies", + "items": { + "type": "string" + } + }, + "tariffZoneConstraint": { + "type": "string", + "description": "Tariff zone constraint", + "enum": [ + "ANY", + "SAME", + "SAME_AS_ORIGIN", + "SAME_AS_DESTINATION", + "SAME_AS_ORIGIN_OR_DESTINATION", + "WITHIN", + "CONTAINING", + "EQUIVALENT", + "DIFFERENT" + ] + }, + "typeOfProductCategoryConstraint": { + "type": "string", + "description": "Type of product category constraint", + "enum": [ + "ANY", + "SAME", + "SAME_OR_EQUIVALENT", + "DIFFERENT" + ] + }, + "typeOfTravelDocumentConstraint": { + "type": "string", + "description": "Type of travel document constraint", + "enum": [ + "ANY", + "SAME", + "SAME_MEDIA", + "SAME_SMART_CARD", + "SAME_MOBILE_APP", + "DIFFERENT" + ] + }, + "userConstraint": { + "type": "string", + "description": "User constraint", + "enum": [ + "ANYONE", + "SAME_PERSON", + "DIFFERENT_PERSON", + "SPECIFIC" + ] + } + }, + "description": "Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.", + "readOnly": true + }, + "EntitlementGiven": { + "required": [ + "changed", + "created", + "description", + "entitlementType", + "fareFrameRef", + "id", + "modification", + "name", + "nameOfClass", + "prices", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "entitlementConstraint": { + "$ref": "#/components/schemas/EntitlementConstraint" + }, + "entitlementType": { + "type": "string", + "description": "Entitlement type", + "enum": [ + "USE", + "PURCHASE", + "PURCHASE_AT_DISCOUNT", + "NONE" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:EntitlementGiven:TrondelagCustomerCard" + }, + "minimumQualificationPeriod": { + "type": "string", + "description": "Minimum qualification period", + "example": "01:59:59.999999999" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the entitlement given represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "EntitlementGiven" + }, + "prices": { + "type": "array", + "description": "Prices for the entitlement given.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "serviceAccessRightRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "EntitlementProduct": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "validityConditions" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "type": "string", + "description": "Id.", + "example": "RUT:EntitlementProduct:PersonalTicket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "EntitlementProduct" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "An ENTITLEMENT PRODUCT response." + }, + "EntitlementRequired": { + "required": [ + "changed", + "created", + "description", + "fareFrameRef", + "id", + "modification", + "name", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "entitlementConstraint": { + "$ref": "#/components/schemas/EntitlementConstraint" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "ENT:EntitlementRequired:SingleTicket" + }, + "minimumQualificationPeriod": { + "type": "string", + "description": "Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the entitlement required represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "EntitlementRequired" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Fare prices for the entitlement required.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "serviceAccessRightNetexId": { + "type": "string", + "description": "Reference to the serviceAccessRight required.", + "example": "ENT:PreassignedFareProduct:SingleTicket" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter.", + "example": "ENT:TypeOfUsageParameter:OpenSeating" + }, + "validityConditions": { + "type": "array", + "description": "Pricing rule reference.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "ENT:Version:ER-SingleTicket-1" + } + }, + "description": "Entitlement Required." + }, + "Exchanging": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "allowed": { + "type": "string", + "description": "Allowed.", + "example": "FULL", + "enum": [ + "NONE", + "PARTIAL", + "FULL" + ] + }, + "canChangeClass": { + "type": "boolean", + "description": "Whether user can change class." + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "exchangeableFromAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded from any point after purchase." + }, + "exchangeableFromDuration": { + "type": "string", + "description": "Duration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.", + "example": "PT24H" + }, + "exchangeableTo": { + "type": "string", + "description": "Type of exchange allowed.", + "enum": [ + "ANY_PRODUCT", + "SAME_PRODUCT_SAME_DAY", + "SAME_PRODUCT_ANY_DAY", + "UPGRADE_TO_STANDARD_FARE", + "SPECIFIED_PRODUCTS" + ] + }, + "exchangeableUntilAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded until any point after purchase." + }, + "exchangeableUntilDuration": { + "type": "string", + "description": "Duration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.", + "example": "PT24H" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "hasFee": { + "type": "boolean", + "description": "Has fee." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Exchanging:MiniFlex" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Exchanging" + }, + "numberOfExchangesAllowed": { + "type": "integer", + "description": "Number of times a ticket may be exchanged.", + "format": "int32" + }, + "onlyAtCertainDistributionPoints": { + "type": "boolean", + "description": "Whether distribution is restricted to certain points." + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the exchanging rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "refundBasis": { + "type": "string", + "description": "Basis on which refund is made. See allowed values below.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "resellWhen": { + "type": "string", + "description": "Event marking when the exchangeable status of the ticket changes.", + "example": "NEVER", + "enum": [ + "NEVER", + "BEFORE_START_OF_VALIDITY_PERIOD", + "AFTER_START_OF_VALIDITY_PERIOD", + "AFTER_END_OF_VALIDITY_PERIOD", + "BEFORE_FIRST_USE", + "AFTER_FIRST_USE", + "BEFORE_VALIDATION", + "AFTER_VALIDATION", + "AFTER_PURCHASE" + ] + }, + "specifiedProducts": { + "type": "array", + "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with \u0027exchangeableTo.SPECIFIED_PRODUCTS\u0027", + "items": { + "type": "string" + } + }, + "status": { + "type": "string", + "description": "Exchanging status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "toFareClass": { + "type": "string", + "description": "Fare class to which can be exchanged.", + "enum": [ + "FIRST_CLASS", + "SECOND_CLASS", + "THIRD_CLASS", + "ECONOMY_CLASS", + "BUSINESS_CLASS", + "TURISTA", + "PREFERENTE", + "STANDARD_CLASS", + "PREMIUM_CLASS", + "ANY", + "UNKNOWN" + ] + }, + "unusedTicketsOnly": { + "type": "boolean", + "description": "Unused tickets only." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Exchanging version.", + "example": "NSB:Version:V1" + } + }, + "description": "Exchanging" + }, + "ExchangingAlternatives": { + "required": [ + "exchangingOptions", + "ref" + ], + "type": "object", + "properties": { + "exchangingOptions": { + "type": "array", + "description": "Exchanging alternatives for this element.", + "items": { + "$ref": "#/components/schemas/Exchanging" + } + }, + "ref": { + "$ref": "#/components/schemas/IdAndVersion" + } + }, + "description": "Exchanging alternatives for an element." + }, + "ExchangingInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "allowed": { + "type": "string", + "description": "Allowed.", + "example": "FULL", + "enum": [ + "NONE", + "PARTIAL", + "FULL" + ] + }, + "canChangeClass": { + "type": "boolean", + "description": "Whether user can change class." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "exchangeableFromAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded from any point after purchase." + }, + "exchangeableFromDuration": { + "type": "string", + "description": "Exchangeable from duration.", + "example": "PT24H" + }, + "exchangeableTo": { + "type": "string", + "description": "Type of exchange allowed.", + "enum": [ + "ANY_PRODUCT", + "SAME_PRODUCT_SAME_DAY", + "SAME_PRODUCT_ANY_DAY", + "UPGRADE_TO_STANDARD_FARE", + "SPECIFIED_PRODUCTS" + ] + }, + "exchangeableUntilAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded until any point after purchase." + }, + "exchangeableUntilDuration": { + "type": "string", + "description": "Exchangeable until duration.", + "example": "PT24H" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "hasFee": { + "type": "boolean", + "description": "Has fee." + }, + "id": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Exchanging:MiniFlex" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "numberOfExchangesAllowed": { + "type": "integer", + "description": "Number of times a ticket may be exchanged.", + "format": "int32" + }, + "onlyAtCertainDistributionPoints": { + "type": "boolean", + "description": "Whether distribution is restricted to certain points." + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "refundBasis": { + "type": "string", + "description": "Basis on which refund is made. See allowed values below.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "resellWhen": { + "type": "string", + "description": "Event marking when the exchangeable status of the ticket changes.", + "example": "NEVER", + "enum": [ + "NEVER", + "BEFORE_START_OF_VALIDITY_PERIOD", + "AFTER_START_OF_VALIDITY_PERIOD", + "AFTER_END_OF_VALIDITY_PERIOD", + "BEFORE_FIRST_USE", + "AFTER_FIRST_USE", + "BEFORE_VALIDATION", + "AFTER_VALIDATION,AFTER_PURCHASE" + ] + }, + "specifiedProducts": { + "type": "string", + "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with \u0027exchangeableTo.SPECIFIED_PRODUCTS\u0027." + }, + "toFareClass": { + "type": "string", + "description": "Fare class to which can be exchanged.", + "enum": [ + "FIRST_CLASS", + "SECOND_CLASS", + "THIRD_CLASS", + "ECONOMY_CLASS", + "BUSINESS_CLASS", + "TURISTA", + "PREFERENTE", + "STANDARD_CLASS", + "PREMIUM_CLASS", + "ANY", + "UNKNOWN" + ] + }, + "unusedTicketsOnly": { + "type": "boolean", + "description": "Unused tickets only." + }, + "version": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UsageValidityPeriod version.", + "example": "NSB:Version:V1" + } + } + }, + "FareDayType": { + "required": [ + "changed", + "created", + "description", + "id", + "modification", + "name", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "dayLength": { + "type": "string", + "description": "Day length. Represented as a string formatted according to ISO-8601", + "example": "PT04H" + }, + "description": { + "type": "array", + "description": "Description of fare day type", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "durationAfterPropertiesOfDay": { + "type": "string", + "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", + "example": "PT7H" + }, + "durationBeforePropertiesOfDay": { + "type": "string", + "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", + "example": "PT24H" + }, + "earliestTime": { + "type": "string", + "description": "Earliest time.", + "example": "11:11:11" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareDayType:2HoursValidPlus1" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name of fare day type", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "FareDayType" + }, + "properties": { + "type": "array", + "description": "Properties of day", + "items": { + "$ref": "#/components/schemas/PropertyOfDay" + } + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "timebandRefs": { + "type": "array", + "description": "Time band references.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "The FareDayType describe during which the assignment applies" + }, + "FareFrame": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareProducts": { + "type": "array", + "description": "FareProducts.", + "items": { + "$ref": "#/components/schemas/FareProduct" + } + }, + "fareStructureElements": { + "type": "array", + "description": "FareStructureElements.", + "items": { + "$ref": "#/components/schemas/FareStructureElement" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareFrame:Child" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "FareFrame Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "FareFrame" + }, + "salesPackages": { + "type": "array", + "description": "SalesPackages.", + "items": { + "$ref": "#/components/schemas/SalesPackage" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "transportOrganisationNameOfClass": { + "type": "string", + "description": "Transport organisation nameOfClass.", + "example": "16" + }, + "transportOrganisationNetexId": { + "type": "string", + "description": "Transport organisation netexId." + }, + "transportOrganisationRef": { + "type": "string", + "description": "Transport organisation ref.", + "example": "CHILD" + }, + "transportOrganisationVersion": { + "type": "string", + "description": "Transport organisation version.", + "example": "4" + }, + "typeOfFareFrameNetexId": { + "type": "string", + "description": "Type of fareFrame netexId." + }, + "typeOfFareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "typeOfFareFrameVersion": { + "type": "string", + "description": "Type of fareFrame version." + }, + "validableElements": { + "type": "array", + "description": "ValidableElements.", + "items": { + "$ref": "#/components/schemas/ValidableElement" + } + }, + "validityConditions": { + "type": "array", + "description": "Validity condition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "vehicleMode": { + "type": "string", + "description": "Vehicle mode.", + "enum": [ + "AIR", + "BUS", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TRAM", + "UNKNOWN" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "FareFrame version.", + "example": "NSB:Version:V1" + } + }, + "description": "A FareFrame" + }, + "FarePointInPattern": { + "required": [ + "id", + "journeyPatternRef", + "modification", + "orderOfElement", + "pointRef", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:FarePointInPattern:TrondheimOslo" + }, + "journeyPatternRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "FarePointInPattern" + }, + "orderOfElement": { + "type": "integer", + "description": "Order of element", + "format": "int32" + }, + "pointRef": { + "type": "string", + "description": "Point Ref" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "Validity Conditions.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "type": "string", + "description": "Version, will be a versioned child of journey pattern", + "readOnly": true, + "example": "NSB:Version:V1" + } + }, + "description": "A Fare Point In Pattern" + }, + "FarePrice": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "amount": { + "type": "string", + "description": "Amount", + "example": "164.0" + }, + "canBeCumulative": { + "type": "boolean", + "description": "canBeCumulative.", + "example": true + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "currency": { + "type": "string", + "description": "Currency.", + "example": "NOK" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "discountPercentageUsed": { + "maximum": 100, + "minimum": -100, + "type": "integer", + "description": "discountPercentageUsed.", + "format": "int32", + "example": 5 + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "type": "string", + "description": "Id.", + "example": "NSB:FarePrice:1005TEN" + }, + "isAllowed": { + "type": "boolean", + "description": "isAllowed.", + "example": true + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "FarePrice" + }, + "ranking": { + "type": "integer", + "description": "Ranking.", + "format": "int32", + "example": 1 + }, + "rounding": { + "$ref": "#/components/schemas/Rounding" + }, + "roundingRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "vatRegisterGroup": { + "type": "string", + "description": "vatRegisterGroup.", + "example": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "type": "string", + "description": "Version.", + "readOnly": true, + "example": "NSB:Version:V1" + } + }, + "description": "A description of the price and factor for a set fare" + }, + "FarePriceInsert": { + "required": [ + "fareFrameRef", + "id", + "name" + ], + "type": "object", + "properties": { + "amount": { + "type": "string", + "description": "Amount.", + "example": "164.0" + }, + "canBeCumulative": { + "type": "boolean", + "description": "canBeCumulative.", + "example": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "currency": { + "type": "string", + "description": "Currency.", + "example": "NOK" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "discountPercentageUsed": { + "type": "integer", + "description": "discountPercentageUsed.", + "format": "int32", + "example": 5 + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FarePrice:1005TEN" + }, + "isAllowed": { + "type": "boolean", + "description": "isAllowed.", + "example": true + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "ranking": { + "type": "integer", + "description": "Ranking.", + "format": "int32", + "example": 1 + }, + "rounding": { + "$ref": "#/components/schemas/RoundingInsert" + }, + "roundingRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "vatRegisterGroup": { + "type": "string", + "description": "vatRegisterGroup.", + "example": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "type": "string" + } + } + }, + "FarePriceUpdate": { + "type": "object", + "properties": { + "amount": { + "type": "number", + "description": "Amount in the currency selected at create operation", + "format": "double", + "example": 16.5 + }, + "discountPercentageUsed": { + "type": "integer", + "description": "Discount in percentageUsed", + "format": "int32", + "example": 40 + } + } + }, + "FareProduct": { + "required": [ + "accessRightParameterAssignments", + "accessRightsInProduct", + "changed", + "chargingMoment", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "validityConditions" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active for this SP.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "SalesPackage changed datetime." + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "SalesPackage create datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:PreassignedFareProduct:RuterSingleTicket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "PreassignedFareProduct" + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the fareProduct" + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT" + }, + "FareQuotaFactor": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareStructureElementRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:FareQuotaFactor:SomeFareQuota4" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "FareQuotaFactor" + }, + "numberOfUnits": { + "type": "integer", + "description": "The number of units.", + "format": "int32" + }, + "prices": { + "type": "array", + "description": "Fare prices for the fare quota factor.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "Gives a sequence of conditions for validity.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "value": { + "type": "string", + "description": "The value of fare quota factor." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored", + "example": "ENT:Version:SomeVersion4" + } + }, + "description": "A FareQuotaFactor" + }, + "FareScheduledStopPoint": { + "type": "object", + "properties": { + "stopPlaceNetexId": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Stop place Netex Id" + }, + "stopPointNetexId": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Stop point Netex Id" + } + }, + "description": "FareScheduledStopPoint, stopPlace and stopPoint Netex Ids should point to same location" + }, + "FareSection": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fromFarePointRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:FareSection:TrondheimOslo" + }, + "journeyPatternRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "FareSection" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "toFarePointRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A Fare section." + }, + "FareStructureElement": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "geographicalIntervalRefs", + "geographicalStructureFactorRefs", + "id", + "modification", + "nameOfClass", + "parameterAssignments", + "pointToPointFareRefs", + "qualityStructureFactorRefs", + "status", + "validityConditions" + ], + "type": "object", + "properties": { + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "fare table reference", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "geographicalIntervalRefs": { + "type": "array", + "description": "geographical interval sequence", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "geographicalStructureFactorRefs": { + "type": "array", + "description": "geographical structure factor refs", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareStructureElement:TENInterval" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "FareStructureElement" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile", + "readOnly": true + }, + "parameterAssignments": { + "type": "array", + "description": "Access Right Parameter assignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "pointToPointFareRefs": { + "type": "array", + "description": "Field is deprecated. Distance matrix elements should be connected by a \u0027geographical structure factor\u0027", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "qualityStructureFactorRefs": { + "type": "array", + "description": "quality structure factor refs", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "tariffBasis": { + "type": "string", + "description": "Tariff basis.", + "example": "DISTANCE", + "enum": [ + "FLAT", + "DISTANCE", + "UNIT_SECTION", + "ZONE", + "ZONE_TO_ZONE", + "POINT_TO_POINT", + "ROUTE", + "TOUR", + "GROUP", + "DISCOUNT", + "PERIOD", + "FREE", + "OTHER" + ] + }, + "validityConditions": { + "type": "array", + "description": "ValidityConditions sequence.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A element describing the response structure of the fare" + }, + "FareStructureElementInSequence": { + "required": [ + "accessNumber", + "changed", + "created", + "fareFrameRef", + "fareStructureElementId", + "fareStructureElementRef", + "id", + "nameOfClass", + "version" + ], + "type": "object", + "properties": { + "accessNumber": { + "type": "integer", + "description": "The actual ordering in the sequence", + "format": "int32" + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementId": { + "type": "string", + "description": "Fare structure element ref" + }, + "fareStructureElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareStructureElementInSequence:MiniPriceTENInterval" + }, + "isFirstInSequence": { + "type": "boolean", + "description": "Gives information if this sequence first or not" + }, + "isLastInSequence": { + "type": "boolean", + "description": "Gives information if this sequence last or not" + }, + "limitedAccessNumber": { + "type": "integer", + "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", + "format": "int32" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "FareStructureElementInSequence" + }, + "orderOfElement": { + "type": "integer", + "description": "Access quality structure factor refs", + "format": "int32" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Fare structure element in sequence version.", + "example": "NSB:Version:V1" + } + }, + "description": "A description of a fare structure element in sequence" + }, + "FareStructureElementInSequenceInsert": { + "required": [ + "fareFrameRef", + "fareStructureElementId", + "id", + "version" + ], + "type": "object", + "properties": { + "accessNumber": { + "type": "integer", + "description": "The actual access number", + "format": "int32" + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementId": { + "type": "string", + "description": "Fare structure element id", + "example": "NSB:FareStructureElement:TENInterval" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareStructureElementInSequence:MiniPriceTENInterval" + }, + "isFirstInSequence": { + "type": "boolean", + "description": "Whether element is first in sequence" + }, + "isLastInSequence": { + "type": "boolean", + "description": "Whether element is last in sequence" + }, + "limitedAccessNumber": { + "type": "integer", + "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", + "format": "int32" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "orderOfElement": { + "type": "integer", + "description": "Access quality structure factor refs", + "format": "int32" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "FareStructureElementInsert": { + "required": [ + "fareFrameRef", + "fareTableRefs", + "geographicalIntervalRefs", + "id", + "parameterAssignmentRefs" + ], + "type": "object", + "properties": { + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "fare table reference", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "geographicalIntervalRefs": { + "type": "array", + "description": "geographical interval sequence", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "geographicalStructureFactorId": { + "type": "string", + "description": "Geographical structure factor id", + "example": "NSB:GeographicalStructureFactor:TENPrices" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareStructureElement:TENInterval" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "parameterAssignmentRefs": { + "type": "array", + "description": "Access Right Parameter assignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "pointToPointFareRefs": { + "type": "array", + "description": "Field is deprecated. Use \u0027geographical structure factor\u0027 instead to connect \u0027distance matrix elements\u0027 to \u0027fare structure element\u0027", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "tariffBasis": { + "type": "string", + "description": "Tariff basis.", + "example": "DISTANCE", + "enum": [ + "FLAT", + "DISTANCE", + "UNIT_SECTION", + "ZONE", + "ZONE_TO_ZONE", + "POINT_TO_POINT", + "ROUTE", + "TOUR", + "GROUP", + "DISCOUNT", + "PERIOD", + "FREE", + "OTHER" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "FareStructureElementPageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "Fare structure elements for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/FareStructureElement" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Number of the requested page. In case state is lost", + "format": "int32", + "example": 369 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "FareTablePageWrapper" + }, + "FareTable": { + "required": [ + "cells", + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "prices", + "status", + "version" + ], + "type": "object", + "properties": { + "cells": { + "type": "array", + "description": "Cell", + "items": { + "$ref": "#/components/schemas/Cell" + } + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "endDate": { + "type": "string", + "description": "EndDate.", + "format": "date", + "example": "2017-11-11" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareTable:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "FareTable" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the fare table", + "readOnly": true + }, + "prices": { + "type": "array", + "description": "FarePrice.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "startDate": { + "type": "string", + "description": "StartDate.", + "format": "date", + "example": "2017-11-11" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A FareTable" + }, + "FareTableInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "cells": { + "type": "array", + "description": "Cell", + "items": { + "$ref": "#/components/schemas/CellInsert" + } + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "endDate": { + "type": "string", + "description": "EndDate.", + "format": "date" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FareTable:Ordinary" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "FarePrice.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "startDate": { + "type": "string", + "description": "StartDate.", + "format": "date" + }, + "tariffRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "FareTablePageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "Fare Tables for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/FareTable" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Number of the requested page. In case state is lost", + "format": "int32", + "example": 369 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "FareTablePageWrapper" + }, + "FareTableRef": { + "type": "object", + "properties": { + "nameOfRefClass": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "FrequencyOfUse": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Frequency of use changed datetime.", + "format": "date-time" + }, + "created": { + "type": "string", + "description": "Frequency of use created datetime.", + "format": "date-time" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "frequencyOfUseType": { + "type": "string", + "description": "Frequency of use type.", + "example": "SINGLE", + "enum": [ + "NONE", + "SINGLE", + "LIMITED", + "UNLIMITED", + "TWICE_A_DAY" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FrequencyOfUse:Single" + }, + "maximalFrequency": { + "type": "integer", + "description": "Maximal frequency given for this frequency of use.", + "format": "int32" + }, + "minimalFrequency": { + "type": "integer", + "description": "Minimal frequency given for this frequency of use.", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "FrequencyOfUse" + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the refunding rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Frequency of use version.", + "example": "NSB:Version:V1" + } + }, + "description": "Frequency of use" + }, + "FrequencyOfUseInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "frequencyOfUseType": { + "type": "string", + "description": "Frequency of use type.", + "example": "SINGLE", + "enum": [ + "NONE", + "SINGLE", + "LIMITED", + "UNLIMITED", + "TWICE_A_DAY" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FrequencyOfUse:Single" + }, + "maximalFrequency": { + "type": "integer", + "description": "Maximal frequency given for this frequency of use.", + "format": "int32" + }, + "minimalFrequency": { + "type": "integer", + "description": "Minimal frequency given for this frequency of use.", + "format": "int32" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the frequency of use.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Frequency of use version.", + "example": "NSB:Version:V1" + } + } + }, + "FulfilmentMethod": { + "required": [ + "changed", + "created", + "description", + "fareFrameRef", + "id", + "name", + "prices", + "status", + "typesOfTravelDocument", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fulfilmentMethodType": { + "type": "string", + "description": "Type of fulfilment method.", + "enum": [ + "TICKET_OFFICE", + "TICKET_MACHINE", + "CONDUCTOR", + "AGENT", + "POST", + "SELFPRINT", + "SMS", + "TOP_UP_DEVICE", + "VALIDATOR", + "MOBILE_APP", + "CUSTOMER_ACCOUNT", + "OTHER" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:FulfilmentMethod:TicketOffice" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the fulfilment method represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "FulfilmentMethod" + }, + "prices": { + "type": "array", + "description": "Prices for the fulfilment method.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "requiresBookingReference": { + "type": "boolean", + "description": "Whether collecting ticket requires booking reference." + }, + "requiresCard": { + "type": "boolean", + "description": "Whether collecting ticket requires credit card used to purchase." + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typesOfTravelDocument": { + "type": "array", + "description": "Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "GeneralGroupOfEntities": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "members", + "modification", + "nameOfClass", + "nameOfMemberClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:GeneralGroupOfEntities:SomeId" + }, + "members": { + "type": "array", + "description": "Member refs.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "GeneralGroupOfEntities" + }, + "nameOfMemberClass": { + "type": "string", + "description": "Name of member class" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the general group of entities.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "GeneralGroupOfEntities version.", + "example": "ENT:Version:SomeVersion" + } + }, + "description": "General Group of Entities." + }, + "GenericParameterAssignment": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "canIgnoreInOffering": { + "type": "boolean", + "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", + "example": true + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "chargingBasisType": { + "type": "string", + "description": "ChargingBasisType.", + "example": "FREE", + "enum": [ + "FREE", + "DISCOUNTED", + "NORMAL", + "ANY" + ] + }, + "comparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether a gpa belongs to A or E gpa implementation.", + "example": "A" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef.", + "example": "NSB:Version:V1" + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "example": "NSB:Version:V1" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GenericParameterAssignment:AllowedOperators" + }, + "includes": { + "type": "array", + "description": "Includes genericParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "includesGroupingType": { + "type": "string", + "description": "Includes grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "limitationGroupingType": { + "type": "string", + "description": "Limitation grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "limitations": { + "type": "array", + "description": "Limitations as UsageParameters.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "example": "GenericParameterAssignment" + }, + "parentParameterAssignmentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "requiredElements": { + "type": "array", + "description": "Required elements.", + "items": { + "type": "string" + } + }, + "requiredInContext": { + "type": "string", + "description": "Required in context.", + "enum": [ + "OFFERING", + "BOOKING", + "RESERVATION", + "SALE", + "FULFILMENT", + "ACTIVATION", + "CONSUMPTION", + "REVALIDATION" + ] + }, + "requiredType": { + "type": "string", + "description": "Required type.", + "example": "SERVICE_JOURNEY_REF", + "enum": [ + "SERVICE_JOURNEY_REF", + "TARIFF_ZONE_REF", + "PASSENGER_SEAT_REF", + "USER_PROFILE_REF", + "USAGE_VALIDITY_PERIOD_REF", + "DATED_SERVICE_JOURNEY_REF", + "DYNAMIC_DISTANCE_MATRIX_ELEMENT", + "USAGE_VALIDITY_PERIOD", + "DISTANCE_MATRIX_ELEMENT_REF", + "SCHEDULED_STOP_POINT_REF", + "GROUP_TICKET_REF", + "GROUP_TICKET", + "GROUP_OF_TARIFF_ZONES_REF", + "FARE_ZONE_REF" + ] + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "temporalValidityParameters": { + "type": "array", + "description": "Temporal validity parameter.", + "items": { + "$ref": "#/components/schemas/TemporalValidityParameter" + } + }, + "typeOfAccessRightAssignment": { + "$ref": "#/components/schemas/TypeOfAccessRightAssignment" + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityParameterAssignmentType": { + "type": "string", + "description": "Validity parameter assignment type.", + "example": "EQ", + "enum": [ + "EQ", + "NE", + "GT", + "LT", + "GE", + "LE" + ] + }, + "validityParameterGroupingType": { + "type": "string", + "description": "Validity parameter grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "validityParameterSetSelectionType": { + "type": "string", + "description": "Validity parameter set operator.", + "enum": [ + "ONE_OF_ANY_ONE_SET", + "ONE_OF_EACH_SET", + "SOME_OF_ANY_SET", + "ALL_OF_ONE_SET", + "ALL_OF_ALL_SETS" + ] + }, + "validityParameters": { + "type": "array", + "description": "Validity parameters as scoping validity parameters", + "items": { + "$ref": "#/components/schemas/ScopingValidityParameter" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V2" + } + }, + "description": "A GenericParameterAssignment" + }, + "GenericParameterAssignmentInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "canIgnoreInOffering": { + "type": "boolean", + "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", + "example": true + }, + "chargingBasisType": { + "type": "string", + "description": "ChargingBasisType.", + "example": "FREE", + "enum": [ + "FREE", + "DISCOUNTED", + "NORMAL", + "ANY" + ] + }, + "comparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether a gpa belongs to A or E gpa implementation.", + "example": "A" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef.", + "example": "NSB:Version:V1" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "example": "NSB:Version:V1" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GenericParameterAssignment:AllowedOperators" + }, + "includes": { + "type": "array", + "description": "Includes genericParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignmentInsert" + } + }, + "includesGroupingType": { + "type": "string", + "description": "Includes grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "limitationGroupingType": { + "type": "string", + "description": "Limitation grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "limitations": { + "type": "array", + "description": "Limitations as UsageParameters.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "parentParameterAssignmentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "requiredElements": { + "type": "string", + "description": "Required elements.", + "example": "START_DATE", + "enum": [ + "START_DATE", + "START_TIME", + "STANDARD_DURATION", + "START_STOP_POINT_REF", + "END_STOP_POINT_REF", + "START_TARIFF_ZONE_REF", + "END_TARIFF_ZONE_REF" + ] + }, + "requiredInContext": { + "type": "string", + "description": "Required in context.", + "enum": [ + "OFFERING", + "BOOKING", + "RESERVATION", + "SALE", + "FULFILMENT", + "ACTIVATION", + "CONSUMPTION", + "REVALIDATION" + ] + }, + "requiredType": { + "type": "string", + "description": "Required type.", + "example": "SERVICE_JOURNEY_REF", + "enum": [ + "SERVICE_JOURNEY_REF", + "TARIFF_ZONE_REF", + "PASSENGER_SEAT_REF", + "USER_PROFILE_REF", + "USAGE_VALIDITY_PERIOD_REF", + "DATED_SERVICE_JOURNEY_REF", + "DYNAMIC_DISTANCE_MATRIX_ELEMENT", + "USAGE_VALIDITY_PERIOD", + "DISTANCE_MATRIX_ELEMENT_REF", + "SCHEDULED_STOP_POINT_REF", + "GROUP_TICKET_REF", + "GROUP_TICKET", + "GROUP_OF_TARIFF_ZONES_REF", + "FARE_ZONE_REF" + ] + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "temporalValidityParameters": { + "type": "array", + "description": "Temporal Validity parameter.", + "items": { + "$ref": "#/components/schemas/TemporalValidityParameterInsert" + } + }, + "typeOfAccessRightAssignment": { + "$ref": "#/components/schemas/TypeOfAccessRightAssignment" + }, + "validableElementRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityParameterAssignmentType": { + "type": "string", + "description": "Validity parameter assignment type.", + "example": "EQ", + "enum": [ + "EQ", + "NE", + "GT", + "LT", + "GE", + "LE" + ] + }, + "validityParameterGroupingType": { + "type": "string", + "description": "Validity parameter grouping type.", + "example": "AND", + "enum": [ + "AND", + "OR", + "XOR", + "NOT" + ] + }, + "validityParameterSetSelectionType": { + "type": "string", + "description": "Validity parameter set operator.", + "enum": [ + "ONE_OF_ANY_ONE_SET", + "ONE_OF_EACH_SET", + "SOME_OF_ANY_SET", + "ALL_OF_ONE_SET", + "ALL_OF_ALL_SETS" + ] + }, + "validityParameters": { + "type": "array", + "description": "Validity parameters as scoping validity parameters", + "items": { + "$ref": "#/components/schemas/ScopingValidityParameterInsert" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V2" + } + } + }, + "GeographicalInterval": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "endGeographicalValue": { + "type": "integer", + "description": "endGeographicalValue.", + "format": "int64" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "Reference to fare table.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GeographicalInterval:1364TEN" + }, + "intervalType": { + "type": "string", + "description": "intervalType.", + "enum": [ + "STOP", + "TARIFF_ZONE", + "DISTANCE", + "COUPON", + "OTHER" + ] + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "GeographicalInterval" + }, + "numberOfUnits": { + "type": "number", + "description": "numberOfUnits.", + "format": "double" + }, + "prices": { + "type": "array", + "description": "Prices for the fare.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "startGeographicalValue": { + "type": "integer", + "description": "startGeographicalValue.", + "format": "int64" + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "validityConditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "GeographicalInterval" + }, + "GeographicalIntervalInsert": { + "required": [ + "fareFrameRef", + "fareTableRefs", + "id", + "prices" + ], + "type": "object", + "properties": { + "endGeographicalValue": { + "type": "integer", + "description": "EndGeographicalValue.", + "format": "int64" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "Reference to fare table.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GeographicalInterval:1364TEN" + }, + "intervalType": { + "type": "string", + "description": "IntervalType.", + "enum": [ + "STOP", + "TARIFF_ZONE", + "DISTANCE", + "COUPON", + "OTHER" + ] + }, + "numberOfUnits": { + "type": "number", + "description": "NumberOfUnits.", + "format": "double" + }, + "prices": { + "type": "array", + "description": "Prices for the fare.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "startGeographicalValue": { + "type": "integer", + "description": "StartGeographicalValue.", + "format": "int64" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "GeographicalStructureFactor": { + "required": [ + "changed", + "created", + "description", + "distanceMatrixElements", + "fareFrameRef", + "geographicalIntervals", + "id", + "modification", + "name", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distanceMatrixElements": { + "type": "array", + "description": "Distance matrix elements", + "items": { + "$ref": "#/components/schemas/DistanceMatrixElement" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "geographicalIntervals": { + "type": "array", + "description": "Geographical intervals", + "items": { + "$ref": "#/components/schemas/GeographicalInterval" + } + }, + "geographicalUnitRef": { + "type": "string", + "description": "Geographical unit ref" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:GeographicalStructureFactor:50TEN" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the geographical structure factor represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "GeographicalStructureFactor" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "GroupOfDistanceMatrixElements": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "membersId", + "nameOfClass", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameId": { + "type": "integer", + "description": "Fare frame id.", + "format": "int64" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GroupOfDistanceMatrixElements:TENDistances" + }, + "membersId": { + "type": "string", + "description": "DistanceMatrixElements within the group." + }, + "name": { + "type": "array", + "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "GroupOfDistanceMatrixElements" + }, + "tariffId": { + "type": "integer", + "description": "Tariff id.", + "format": "int64" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "GroupOfDistanceMatrixElements version.", + "example": "NSB:Version:V1" + } + }, + "description": "A GroupfOfDistanceMatrixElemenets" + }, + "GroupOfDistanceMatrixElementsInsert": { + "required": [ + "fareFrameRef", + "id", + "members", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameId": { + "type": "integer", + "description": "Fare frame id.", + "format": "int64" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GroupOfDistanceMatrixElements:TENDistances" + }, + "members": { + "type": "array", + "description": "DistanceMatrixElements within the group.", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "tariffId": { + "type": "integer", + "description": "Tariff id.", + "format": "int64" + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "GroupOfDistanceMatrixElements version.", + "example": "NSB:Version:V1" + } + }, + "description": "A GroupDistanceMatrixElement create request" + }, + "GroupOfTimeBands": { + "required": [ + "changed", + "created", + "id", + "members", + "modification", + "nameOfClass", + "status", + "validityConditions" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id." + }, + "members": { + "type": "array", + "description": "Members.", + "items": { + "$ref": "#/components/schemas/Timeband" + } + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "FareStructureElement" + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "ValidityConditions sequence.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A GroupOfTimeband describe during which the assignments applies" + }, + "GroupTicket": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "companionProfiles": { + "type": "array", + "description": "Companion Profiles in Group Ticket", + "items": { + "$ref": "#/components/schemas/CompanionProfile" + } + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the group ticket.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "groupDiscountBasis": { + "type": "string", + "description": "groupDiscountBasis", + "enum": [ + "FREE", + "DISCOUNT_FOR_ALL", + "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", + "STEP_DISCOUNT", + "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GroupTicket:FamilyDiscount" + }, + "jointCheckIn": { + "type": "string", + "description": "jointCheckIn", + "enum": [ + "NONE", + "ALLOWED", + "REQUIRED" + ] + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "maximumNumberOfPersons": { + "type": "integer", + "description": "maximumNumberOfPersons", + "format": "int32" + }, + "minimumNumberOfPersons": { + "type": "integer", + "description": "minimumNumberOfPersons", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the group ticket represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "GroupTicket" + }, + "prices": { + "type": "array", + "description": "Fare prices for the group ticket.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "pricingBasis": { + "type": "string", + "description": "Price basis", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "ticketing": { + "type": "string", + "description": "The type of way that tickets are issued to the group.", + "example": "SEPARATE_TICKETS", + "enum": [ + "ALL_ON_ONE_TICKET", + "SEPARATE_TICKETS", + "TICKET_WITH_COUPONS", + "OTHER" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the group ticket.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "The version of the group ticket.", + "example": "NSB:Version:V1" + } + }, + "description": "A GroupTicket" + }, + "GroupTicketInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "companionProfiles": { + "type": "array", + "description": "Companion Profiles in Group Ticket", + "items": { + "$ref": "#/components/schemas/CompanionProfile" + } + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupDiscountBasis": { + "type": "string", + "description": "groupDiscountBasis", + "enum": [ + "FREE", + "DISCOUNT_FOR_ALL", + "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", + "STEP_DISCOUNT", + "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" + ] + }, + "id": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:GroupTicket:FamilyDiscount" + }, + "jointCheckIn": { + "type": "string", + "description": "jointCheckIn", + "enum": [ + "NONE", + "ALLOWED", + "REQUIRED" + ] + }, + "maximumNumberOfPersons": { + "type": "integer", + "description": "maximumNumberOfPersons", + "format": "int32" + }, + "minimumNumberOfPersons": { + "type": "integer", + "description": "minimumNumberOfPersons", + "format": "int32" + }, + "name": { + "type": "array", + "description": "The name of the group ticket represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices for the group ticket.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "pricingBasis": { + "type": "string", + "description": "Price basis", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "ticketing": { + "type": "string", + "description": "The type of way that tickets are issued to the group.", + "example": "SEPARATE_TICKETS", + "enum": [ + "ALL_ON_ONE_TICKET", + "SEPARATE_TICKETS", + "TICKET_WITH_COUPONS", + "OTHER" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "version": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "The version of the group ticket.", + "example": "NSB:Version:V1" + } + }, + "description": "A group ticket create request" + }, + "IdAndVersion": { + "required": [ + "id", + "version" + ], + "type": "object", + "properties": { + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "ID of the element." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version of the element." + } + }, + "description": "Describes the ID and version of an element." + }, + "Interchanging": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fromMode": { + "type": "string", + "description": "Vehicle fromMode.", + "enum": [ + "AIR", + "BUS", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TRAM", + "UNKNOWN" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Interchanging:Trondelag" + }, + "maximumNumberOfChanges": { + "type": "integer", + "description": "MaximumNumberOfChanges.", + "format": "int32" + }, + "maximumTimeToMakeATransfer": { + "type": "string", + "description": "MaximumTimeToMakeATransfer" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Interchanging" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "toMode": { + "type": "string", + "description": "Vehicle toMode.", + "enum": [ + "AIR", + "BUS", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TRAM", + "UNKNOWN" + ] + }, + "typeOfUsageParameterRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "InterchangingInsert": { + "required": [ + "fareFrameRef", + "id", + "name" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fromMode": { + "type": "string", + "description": "Vehicle fromMode.", + "enum": [ + "AIR", + "BUS", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TRAM", + "UNKNOWN" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Interchanging:Trondelag" + }, + "maximumNumberOfChanges": { + "type": "integer", + "description": "MaximumNumberOfChanges.", + "format": "int32" + }, + "maximumTimeToMakeATransfer": { + "type": "string", + "description": "MaximumTimeToMakeATransfer" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "toMode": { + "type": "string", + "description": "Vehicle toMode.", + "enum": [ + "AIR", + "BUS", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TRAM", + "UNKNOWN" + ] + }, + "typeOfUsageParameterRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "JourneyPattern": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "farePointsInPattern": { + "type": "array", + "description": "Fare points in pattern. Versioned child of JourneyPattern", + "items": { + "$ref": "#/components/schemas/FarePointInPattern" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:JourneyPattern:TrondheimOslo" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "FareSection" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A Journey Pattern" + }, + "LimitingRule": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "canBeCumulative": { + "type": "boolean", + "description": "CanBeCumulative." + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "discountAsPercentage": { + "type": "number", + "description": "DiscountAsPercentage.", + "format": "float" + }, + "discountAsValue": { + "type": "number", + "description": "DiscountAsValue.", + "format": "float" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id." + }, + "maximumPrice": { + "type": "string", + "description": "MaximumPrice.", + "example": "164.0" + }, + "maximumPriceAsPercentage": { + "type": "number", + "description": "MaximumPriceAsPercentage.", + "format": "double" + }, + "minimumLimitPrice": { + "type": "string", + "description": "MinimumLimitPrice.", + "example": "164.0" + }, + "minimumPrice": { + "type": "string", + "description": "MinimumPrice.", + "example": "164.0" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "LimitingRule" + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A LimitingRule" + }, + "ListTextInLanguage": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "LuggageAllowance": { + "required": [ + "changed", + "created", + "description", + "fareFrameRef", + "id", + "modification", + "name", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "baggageType": { + "type": "string", + "description": "Baggage Type", + "enum": [ + "HANDBAG", + "HAND_LUGGAGE", + "SMALL_SUITCASE", + "SUITCASE", + "TRUNK", + "OVERSIZE_ITEM", + "BICYCLE", + "SPORTING_EQUIPMENT", + "SKIS", + "MUSICAL_INSTRUMENT", + "PUSH_CHAIR", + "MOTORIZED_WHEELCHAIR", + "LARGE_MOTORIZED_WHEELCHAIR", + "WHEELCHAIR", + "SMALL_ANIMAL", + "ANIMAL", + "GAME", + "MOTORCYCLE", + "OTHER" + ] + }, + "baggageUseType": { + "type": "string", + "description": "Baggage Use Type", + "enum": [ + "CARRY_ON", + "CHECK_IN", + "OVERSIZE_CHECK_IN" + ] + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:LuggageAllowance:Bicycle" + }, + "luggageAllowanceType": { + "type": "string", + "description": "Luggage Allowance Type", + "enum": [ + "NONE", + "UNLIMITED", + "SINGLE", + "LIMITED" + ] + }, + "luggageChargingBasis": { + "type": "string", + "description": "Luggage Charging Basis", + "enum": [ + "FREE", + "CHARGED_BY_ITEM", + "CHARGED_BY_WEIGHT", + "OTHER" + ] + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "LuggageAllowance" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Prices for the luggage allowance.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "LuggageAllowance" + }, + "MapStringObject": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "Metadata": { + "required": [ + "created", + "id", + "nameOfClass", + "responsible", + "version" + ], + "type": "object", + "properties": { + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "externalReferenceName": { + "type": "string", + "description": "External reference name" + }, + "externalReferenceUrl": { + "type": "string", + "description": "External reference URL" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:SalesPackage:Ordinary" + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "JourneyPattern" + }, + "note": { + "type": "string", + "description": "Note", + "example": "Dette er en endring" + }, + "responsible": { + "minLength": 1, + "type": "string", + "description": "Responsible", + "example": "Kari Nordmann" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "MininmalVersionInfo": { + "required": [ + "changed", + "created", + "id", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "endDate": { + "type": "string", + "description": "EndDate", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Id.", + "readOnly": true, + "example": "NSB:ElementTypeMetadata:Test" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "ElementTypeMetadata" + }, + "startDate": { + "type": "string", + "description": "StartDate", + "format": "date-time", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "type": "string", + "description": "Version", + "readOnly": true, + "example": "NSB:Version:V1" + } + }, + "description": "MininmalVersionInfo" + }, + "NameAndDescription": { + "required": [ + "description", + "name" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + } + } + }, + "OnboardStay": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "duration": { + "type": "string", + "description": "Duration.", + "example": "PT24H" + }, + "fareClass": { + "type": "string", + "description": "Fareclass.", + "example": "FIRST_CLASS", + "enum": [ + "FIRST_CLASS", + "SECOND_CLASS", + "THIRD_CLASS", + "ECONOMY_CLASS", + "BUSINESS_CLASS", + "TURISTA", + "PREFERENTE", + "STANDARD_CLASS", + "PREMIUM_CLASS", + "ANY", + "UNKNOWN" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:OnboardStay:Sleeper" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "OnboardStay" + }, + "permission": { + "type": "string", + "description": "BoardingPermissionEnum.", + "example": "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE", + "enum": [ + "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE", + "DELAYEDALIGHTINGPOSSIBLEAFTERARRIVAL", + "OVERNIGHTSTAYONBOARDALLOWED" + ] + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "An OnboardStay" + }, + "ParameterPossibilitiesRequest": { + "type": "object", + "properties": { + "fareStructureElements": { + "type": "array", + "description": "Fare structure elements the user wants to retrieve the parameter alternatives for.", + "items": { + "$ref": "#/components/schemas/IdAndVersion" + } + }, + "preassignedFareProducts": { + "type": "array", + "description": "Preassigned products the user wants to retrieve the parameter alternatives for.", + "items": { + "$ref": "#/components/schemas/IdAndVersion" + } + }, + "salesPackages": { + "type": "array", + "description": "Sales packages the user wants to retrieve the parameter alternatives for.", + "items": { + "$ref": "#/components/schemas/IdAndVersion" + } + }, + "validableElements": { + "type": "array", + "description": "Validable elements the user wants to retrieve the parameter alternatives for.", + "items": { + "$ref": "#/components/schemas/IdAndVersion" + } + } + }, + "description": "Request for retrieving refunding alternatives for elements." + }, + "PenaltyPolicy": { + "required": [ + "changed", + "created", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "created": { + "type": "string", + "description": "Created", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:PenaltyPolicy:InspectionFeeYoung" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "minimumTimeBeforeReentry": { + "type": "string", + "description": "MinimumTimeBeforeReentry", + "example": "PT24H" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "NameOfClass", + "readOnly": true, + "example": "PenaltyPolicy" + }, + "paymentMethod": { + "type": "string", + "description": "PaymentMethod", + "example": "CASH" + }, + "penaltyAction": { + "type": "string", + "description": "PenaltyAction", + "example": "FINE" + }, + "penaltyPolicyType": { + "type": "string", + "description": "PenaltyPolicyType", + "example": "NO_TICKET" + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the penalty policy.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "sameStationReentryPolicyType": { + "type": "string", + "description": "SameStationReentryPolicyType", + "example": "BLOCKED" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfUsageParameterRef": { + "type": "string", + "description": "typeOfUsageParameter.", + "example": "ENT:TypeOfUsageParameter:OpenSeating" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A PENALTY POLICY" + }, + "PenaltyPolicyAlternatives": { + "required": [ + "penaltyOptions", + "ref" + ], + "type": "object", + "properties": { + "penaltyOptions": { + "type": "array", + "description": "Penalty policy alternatives for this element.", + "items": { + "$ref": "#/components/schemas/PenaltyPolicy" + } + }, + "ref": { + "$ref": "#/components/schemas/IdAndVersion" + } + }, + "description": "Penalty policy alternatives for an element." + }, + "PeriodTicketInfo": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:PreassignedFareProduct:30Days" + }, + "limitations": { + "type": "array", + "description": "Limitations as UsageParameters.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "PeriodTicket with userprofiles and usage validity periods" + }, + "PreassignedFareProduct": { + "required": [ + "accessRightParameterAssignments", + "accessRightsInProduct", + "changed", + "chargingMoment", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "validityConditions", + "vatGroupRegister" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef." + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "POINT_TO_POINT_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:PreassignedFareProduct:RuterSingleTicket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "PreassignedFareProduct" + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "productType": { + "type": "string", + "description": "The type of fare product.", + "example": "SINGLE_TRIP", + "enum": [ + "SINGLE_TRIP", + "TIME_LIMITED_SINGLE_TRIP", + "PERIOD_PASS" + ] + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT." + }, + "PreassignedFareProductInsert": { + "required": [ + "chargingMomentRef", + "fareFrameRef", + "id", + "name", + "operatorRef", + "organisation", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProductInsert" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "chargingMomentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummaryInsert" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:PreassignedFareProduct:RuterSingleTicket" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "operatorRef": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation." + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "productType": { + "type": "string", + "description": "The type of fare product.", + "example": "SINGLE_TRIP", + "enum": [ + "SINGLE_TRIP" + ] + }, + "typeOfFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "PreassignedFareProductPageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "Preassigned fare products for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/PreassignedFareProduct" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Requested page number.", + "format": "int32", + "example": 1 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "PreassignedFareProductWrapper" + }, + "PricingParameterSet": { + "required": [ + "changed", + "compatibleWithVersionRef", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:PricingParameterSet:123abc" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "TypeOfUsageParameter" + }, + "pricingrules": { + "type": "array", + "description": "Different rules that is common for the operator", + "items": { + "$ref": "#/components/schemas/PricingRuleEntity" + } + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "PricingRuleEntity": { + "type": "object", + "properties": { + "description": { + "$ref": "#/components/schemas/ListTextInLanguage" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "type": "string" + }, + "name": { + "$ref": "#/components/schemas/ListTextInLanguage" + }, + "version": { + "type": "string" + } + } + }, + "ProblemDetail": { + "type": "object", + "properties": { + "detail": { + "type": "string" + }, + "instance": { + "type": "string", + "format": "uri" + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "status": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string", + "format": "uri" + } + } + }, + "ProductTreeExplained": { + "required": [ + "id", + "version" + ], + "type": "object", + "properties": { + "explainedElementId": { + "type": "string", + "description": "The netexId of the explained element", + "readOnly": true + }, + "explainedElementNameOfClass": { + "type": "string", + "description": "The nameOfClass of the explained element", + "readOnly": true + }, + "explainedElementVersion": { + "type": "string", + "description": "The version of the explained element", + "readOnly": true + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id for root component/element", + "readOnly": true, + "example": "NSB:SalesPackage:SomeSalesPackage" + }, + "messages": { + "$ref": "#/components/schemas/SeqExplainedMessageResponse" + }, + "nameOfClass": { + "minLength": 1, + "type": "string", + "description": "nameOfClass", + "readOnly": true, + "example": "SalesPackage" + }, + "originalErrorMessage": { + "type": "string", + "description": "The original error message thrown", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "Reason for failed tree", + "readOnly": true, + "example": "invalidProductData" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version for root component/element", + "readOnly": true, + "example": "NSB:Version:V1" + } + }, + "description": "Schema for presenting explained messages for failed product trees" + }, + "PropertyOfDay": { + "required": [ + "countryRef", + "name" + ], + "type": "object", + "properties": { + "countryRef": { + "type": "string", + "description": "Reference to country for holiday. ISO 3166-1", + "readOnly": true, + "example": "NO" + }, + "dayOfYear": { + "type": "string", + "description": "Day of year", + "format": "##-##", + "example": "01-25" + }, + "daysOfWeek": { + "type": "array", + "description": "Days of week", + "items": { + "type": "string" + } + }, + "description": { + "type": "string", + "description": "Description of the property of day", + "example": "Days family discount is available" + }, + "holidayTypes": { + "type": "array", + "description": "Holiday types", + "items": { + "type": "string" + } + }, + "monthOfYear": { + "type": "integer", + "description": "Month of year", + "format": "int32", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12 + ] + }, + "name": { + "type": "string", + "description": "Name of property of day", + "example": "Monday" + } + }, + "description": "The DayType describe during which the assignment applies" + }, + "PurchaseWindow": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:PurchaseWindow:Child" + }, + "latestTime": { + "type": "string", + "description": "Latest time to purchase.", + "example": "23:59:59.999999999" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "maxmumPeriodBeforeDeparture": { + "type": "string", + "description": "Maximum period before departure.", + "example": "23:59:59.999999999" + }, + "minimumPeriodBeforeDeparture": { + "type": "string", + "description": "Minimum period before departure.", + "example": "01:59:59.999999999" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "PurchaseWindow Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "PurchaseWindow" + }, + "purchaseWhen": { + "type": "string", + "description": "When to purchase.", + "example": "ADVANCE_AND_DAY_OF_TRAVEL", + "enum": [ + "TIME_OF_TRAVEL_ONLY", + "DAY_OF_TRAVEL_ONLY", + "ADVANCE_ONLY", + "UNTIL_PREVIOUS_DAY", + "ADVANCE_AND_DAY_OF_TRAVEL", + "OTHER" + ] + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "PurchaseWindow version.", + "example": "NSB:Version:V1" + } + }, + "description": "A PurchaseWindow" + }, + "PurchaseWindowInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:PurchaseWindow:90days" + }, + "latestTime": { + "type": "string", + "description": "Latest time.", + "example": "23:59:59" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "maxmumPeriodBeforeDeparture": { + "type": "string", + "description": "Maximum period before departure.", + "example": "PT2160H" + }, + "minimumPeriodBeforeDeparture": { + "type": "string", + "description": "Minimum period before departure.", + "example": "PT2160H" + }, + "name": { + "type": "array", + "description": "PurchaseWindow Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "purchaseWhen": { + "type": "string", + "description": "When to purchase.", + "example": "ADVANCE_AND_DAY_OF_TRAVEL", + "enum": [ + "TIME_OF_TRAVEL_ONLY", + "DAY_OF_TRAVEL_ONLY", + "ADVANCE_ONLY", + "UNTIL_PREVIOUS_DAY", + "ADVANCE_AND_DAY_OF_TRAVEL", + "OTHER" + ] + }, + "version": { + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "PurchaseWindow version.", + "example": "NSB:Version:V1" + } + } + }, + "Refunding": { + "required": [ + "allowed", + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "allowed": { + "type": "string", + "description": "Allowed.", + "example": "FULL", + "enum": [ + "NONE", + "PARTIAL", + "FULL" + ] + }, + "canChangeClass": { + "type": "boolean", + "description": "Whether user can change class." + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "exchangeableFromAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded from any point after purchase." + }, + "exchangeableFromDuration": { + "type": "string", + "description": "Exchangeable from duration.", + "example": "PT24H" + }, + "exchangeableUntilAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded until any point after purchase." + }, + "exchangeableUntilDuration": { + "type": "string", + "description": "Exchangeable until duration." + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "hasFee": { + "type": "boolean", + "description": "Has fee." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Refunding:FullRefundUntilLimit" + }, + "limitingRule": { + "type": "string", + "description": "Pricing rule." + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Refunding" + }, + "onlyAtCertainDistributionPoints": { + "type": "boolean", + "description": "Whether distribution is restricted to certain points." + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the refunding rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "refundBasis": { + "type": "string", + "description": "Basis on which refund is made. See allowed values below.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "refundType": { + "type": "string", + "description": "Refund type.", + "example": "UNUSED", + "enum": [ + "UNUSED", + "DELAY", + "CANCELLATION", + "PARTIAL_JOURNEY", + "OTHER" + ] + }, + "resellWhen": { + "type": "string", + "description": "Event marking when the refundable status of the ticket changes.", + "example": "NEVER", + "enum": [ + "NEVER", + "BEFORE_START_OF_VALIDITY_PERIOD", + "AFTER_START_OF_VALIDITY_PERIOD", + "AFTER_END_OF_VALIDITY_PERIOD", + "BEFORE_FIRST_USE", + "AFTER_FIRST_USE", + "BEFORE_VALIDATION", + "AFTER_VALIDATION", + "AFTER_PURCHASE" + ] + }, + "status": { + "type": "string", + "description": "Refunding status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "unusedTicketsOnly": { + "type": "boolean", + "description": "Unused tickets only." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Refunding version.", + "example": "NSB:Version:V1" + } + }, + "description": "Refunding" + }, + "RefundingAlternatives": { + "required": [ + "ref", + "refundingOptions" + ], + "type": "object", + "properties": { + "ref": { + "$ref": "#/components/schemas/IdAndVersion" + }, + "refundingOptions": { + "type": "array", + "description": "Refunding alternatives for this element.", + "items": { + "$ref": "#/components/schemas/Refunding" + } + } + }, + "description": "Refunding alternatives for an element." + }, + "RefundingInsert": { + "required": [ + "allowed", + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "allowed": { + "type": "string", + "description": "Allowed.", + "example": "FULL", + "enum": [ + "NONE", + "PARTIAL", + "FULL" + ] + }, + "canChangeClass": { + "type": "boolean", + "description": "Whether user can change class." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "exchangeableFromAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded from any point after purchase." + }, + "exchangeableFromDuration": { + "type": "string", + "description": "Exchangeable from duration." + }, + "exchangeableUntilAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded until any point after purchase." + }, + "exchangeableUntilDuration": { + "type": "string", + "description": "Exchangeable until duration." + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "hasFee": { + "type": "boolean", + "description": "Has fee." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:Refunding:SeatUpgrade" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "onlyAtCertainDistributionPoints": { + "type": "boolean", + "description": "Whether distribution is restricted to certain points." + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the refunding rule.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "refundBasis": { + "type": "string", + "description": "Basis on which refund is made. See allowed values below.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "refundType": { + "type": "string", + "description": "Refund type.", + "example": "UNUSED", + "enum": [ + "UNUSED", + "DELAY", + "CANCELLATION", + "PARTIAL_JOURNEY", + "OTHER" + ] + }, + "resellWhen": { + "type": "string", + "description": "Event marking when the refundable status of the ticket changes.", + "example": "NEVER", + "enum": [ + "NEVER", + "BEFORE_START_OF_VALIDITY_PERIOD", + "AFTER_START_OF_VALIDITY_PERIOD", + "AFTER_END_OF_VALIDITY_PERIOD", + "BEFORE_FIRST_USE", + "AFTER_FIRST_USE", + "BEFORE_VALIDATION", + "AFTER_VALIDATION,AFTER_PURCHASE" + ] + }, + "unusedTicketsOnly": { + "type": "boolean", + "description": "Unused tickets only." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UsageValidityPeriod version.", + "example": "NSB:Version:V1" + } + } + }, + "Replacing": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "allowed": { + "type": "string", + "description": "Allowed.", + "enum": [ + "NONE", + "PARTIAL", + "FULL" + ] + }, + "canChangeClass": { + "type": "boolean", + "description": "Whether user can change class." + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "exchangeableFromAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded from any point after purchase." + }, + "exchangeableFromDuration": { + "type": "string", + "description": "Exchangeable from duration.", + "example": "PT24H" + }, + "exchangeableUntilAnyTime": { + "type": "boolean", + "description": "Can be exchanged or refunded until any point after purchase." + }, + "exchangeableUntilDuration": { + "type": "string", + "description": "Exchangeable until duration." + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare table.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "hasFee": { + "type": "boolean", + "description": "Has fee." + }, + "id": { + "minLength": 1, + "type": "string", + "description": "Id.", + "example": "NSB:Replacing:SomeId" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "Replacing" + }, + "onlyAtCertainDistributionPoints": { + "type": "boolean", + "description": "Whether distribution is restricted to certain points." + }, + "prices": { + "type": "array", + "description": "Fare prices for the replacing.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "refundBasis": { + "type": "string", + "description": "Basis on which refund is made. See allowed values below.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "resellWhen": { + "type": "string", + "description": "Event marking when the exchangeable status of the ticket changes.", + "example": "NEVER", + "enum": [ + "NEVER", + "BEFORE_START_OF_VALIDITY_PERIOD", + "AFTER_START_OF_VALIDITY_PERIOD", + "AFTER_END_OF_VALIDITY_PERIOD", + "BEFORE_FIRST_USE", + "AFTER_FIRST_USE", + "BEFORE_VALIDATION", + "AFTER_VALIDATION", + "AFTER_PURCHASE" + ] + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "unusedTicketsOnly": { + "type": "boolean", + "description": "Unused tickets only." + }, + "validityConditions": { + "type": "array", + "description": "Gives a sequence of conditions for validity.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the replacing.", + "example": "ENT:Version:SomeVersion" + } + }, + "description": "A Replacing" + }, + "Reserving": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "feeBasis": { + "type": "string", + "description": "Fee basis.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Reserving:SeatAsAccommodationReserving" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "maximumNumberToReserve": { + "type": "integer", + "description": "Maximum amount to reserve.", + "format": "int32" + }, + "minimumNumberToReserve": { + "type": "integer", + "description": "Minimum amount to reserve.", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "mustReserveWholeCompartment": { + "type": "boolean", + "description": "Must reserve whole compartment" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Reserving" + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the reserving rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "reservationChargeType": { + "type": "string", + "description": "Type of charge for reservation.", + "example": "NONE", + "enum": [ + "NONE", + "SINGLE_FEE_FOR_RETURN_TRIP", + "FEE_FOR_EACH_DIRECTION", + "FEE_FOR_EACH_LEG" + ] + }, + "reservingRequirements": { + "type": "string", + "description": "Requirements for reservation.", + "example": "RESERVATIONS_COMPULSORY", + "enum": [ + "RESERVATIONS_COMPULSORY", + "RESERVATIONS_COMPULSORY_FOR_GROUPS", + "RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS", + "RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION", + "RESERVATIONS_RECOMMENDED", + "RESERVATIONS_POSSIBLE", + "RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS", + "RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS", + "RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES", + "GROUP_BOOKING_RESTRICTED", + "NO_GROUPS_ALLOWED", + "NO_RESERVATIONS_POSSIBLE", + "WHEELCHAIR_ONLY_RESERVATIONS", + "BICYCLE_RESERVATIONS_COMPULSORY", + "RESERVATION_SUPPLEMENT_CHARGED" + ] + }, + "status": { + "type": "string", + "description": "Reserving status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "Type of usage parameter for the reservation.", + "example": "NSB:TypeOfUsageParameter:OpenSeating" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Reserving version.", + "example": "NSB:Version:V1" + } + }, + "description": "Reserving" + }, + "ReservingInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "feeBasis": { + "type": "string", + "description": "Fee basis.", + "example": "PER_OFFER", + "enum": [ + "PER_OFFER", + "PER_PERSON" + ] + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Reserving:SeatAsAccommodationReserving" + }, + "maximumNumberToReserve": { + "type": "integer", + "description": "Maximum amount to reserve.", + "format": "int32" + }, + "minimumNumberToReserve": { + "type": "integer", + "description": "Minimum amount to reserve.", + "format": "int32" + }, + "mustReserveWholeCompartment": { + "type": "boolean", + "description": "Must reserve whole compartment" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Prices for the reserving.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "reservationChargeType": { + "type": "string", + "description": "Type of charge for reservation.", + "example": "NONE", + "enum": [ + "NONE", + "SINGLE_FEE_FOR_RETURN_TRIP", + "FEE_FOR_EACH_DIRECTION", + "FEE_FOR_EACH_LEG" + ] + }, + "reservingRequirements": { + "type": "string", + "description": "Requirements for reservation.", + "example": "RESERVATIONS_COMPULSORY", + "enum": [ + "RESERVATIONS_COMPULSORY", + "RESERVATIONS_COMPULSORY_FOR_GROUPS", + "RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS", + "RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION", + "RESERVATIONS_RECOMMENDED", + "RESERVATIONS_POSSIBLE", + "RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS", + "RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS", + "RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES", + "GROUP_BOOKING_RESTRICTED", + "NO_GROUPS_ALLOWED", + "NO_RESERVATIONS_POSSIBLE", + "WHEELCHAIR_ONLY_RESERVATIONS", + "BICYCLE_RESERVATIONS_COMPULSORY", + "RESERVATION_SUPPLEMENT_CHARGED" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "Type of usage parameter for the reservation.", + "example": "NSB:TypeOfUsageParameter:ThroughFareInterchanging" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Reserving version.", + "example": "NSB:Version:V1" + } + } + }, + "Reverting": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "allowedAfterControl": { + "type": "boolean", + "description": "Specifies if revert is allowed after control.", + "example": true, + "default": false + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "type": "string", + "description": "Id.", + "example": "NSB:Reverting:SelfService" + }, + "maximumTimeAfterUse": { + "type": "string", + "description": "Maximum time after use Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "minimumTimeAfterUse": { + "type": "string", + "description": "Minimum time after use. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "Reverting" + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the reverting rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Reverting status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfResponsibilityRoleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter.", + "example": "ENT:TypeOfUsageParameter:OpenSeating" + }, + "version": { + "minLength": 1, + "type": "string", + "description": "Reverting version.", + "example": "NSB:Version:V1" + } + }, + "description": "Reverting" + }, + "RoundTrip": { + "required": [ + "changed", + "created", + "doubleSingleFare", + "fareFrameRef", + "id", + "isRequired", + "modification", + "nameOfClass", + "shortTrip", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "doubleSingleFare": { + "type": "boolean", + "description": "Double single fare", + "example": true + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the round trip.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:RoundTrip:Child" + }, + "isRequired": { + "type": "boolean", + "description": "Is required." + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "RoundTrip Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "RoundTrip" + }, + "prices": { + "type": "array", + "description": "Fare prices for the round trip.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "required": { + "type": "boolean" + }, + "shortTrip": { + "type": "boolean", + "description": "Short trip", + "example": true + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "tripType": { + "type": "string", + "description": "Type of round trip", + "enum": [ + "SINGLE", + "RETURN", + "RETURN_ONLY", + "MULTIPLE" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the round trip.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "RoundTrip version.", + "example": "NSB:Version:V1" + } + }, + "description": "A RoundTrip" + }, + "RoundTripInsert": { + "required": [ + "doubleSingleFare", + "fareFrameRef", + "id", + "isRequired", + "name", + "shortTrip", + "version" + ], + "type": "object", + "properties": { + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "example": "NSB:Version:V1" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "example": "NSB:Version:V1" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "doubleSingleFare": { + "type": "boolean", + "description": "Double single fare", + "example": true + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the round trip.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:RoundTrip:Child" + }, + "isRequired": { + "type": "boolean", + "description": "Is required." + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "name": { + "type": "array", + "description": "Round trip Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices for the round trip.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "required": { + "type": "boolean" + }, + "shortTrip": { + "type": "boolean", + "description": "Short trip", + "example": true + }, + "tripType": { + "type": "string", + "description": "Type of round trip", + "enum": [ + "SINGLE", + "RETURN", + "RETURN_ONLY", + "MULTIPLE" + ] + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the round trip.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Round trip version.", + "example": "NSB:Version:V1" + } + }, + "description": "A RoundTrip create request" + }, + "Rounding": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "roundingMethod", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Rounding:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "Rounding" + }, + "roundingMethod": { + "type": "string", + "description": "Type of rounding.", + "enum": [ + "NONE", + "DOWN", + "UP", + "SPLIT", + "STEP_TABLE", + "FIVE", + "NINE", + "TEN", + "FORTY_NINE" + ] + }, + "roundingModulus": { + "type": "number", + "description": "Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.", + "format": "double" + }, + "status": { + "type": "string", + "description": "Rounding status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Rounding version.", + "example": "NSB:Version:V1" + } + }, + "description": "A description of how prices are rounded post calculation", + "deprecated": true + }, + "RoundingInsert": { + "required": [ + "fareFrameRef", + "id", + "roundingMethod", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Rounding:Ordinary" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "roundingMethod": { + "type": "string", + "description": "Type of rounding.", + "enum": [ + "NONE", + "DOWN", + "UP", + "SPLIT", + "STEP_TABLE", + "FIVE", + "NINE", + "TEN", + "FORTY_NINE" + ] + }, + "roundingModulus": { + "type": "number", + "description": "Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.", + "format": "double" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Rounding version.", + "example": "NSB:Version:V1" + } + }, + "description": "Rounding.", + "deprecated": true + }, + "SaleDiscountRight": { + "required": [ + "accessRightParameterAssignments", + "accessRightsInProduct", + "changed", + "chargingMoment", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "organisation", + "prices", + "status", + "validityConditions", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "SalesPackage changed datetime.", + "readOnly": true + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef", + "readOnly": true + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "SalesPackage create datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:PreassignedFareProduct:RuterSingleTicket" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "PreassignedFareProduct" + }, + "operatorRef": { + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation who own the product." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Prices for the sdr.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "typeOfFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validationRequirements": { + "type": "string", + "description": "A set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", + "example": "[\"IDENTIFIABLE_CUSTOMER\"]" + }, + "validityConditions": { + "type": "array", + "description": "ValidityCondition.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A Sale Discount Right response" + }, + "SaleDiscountRightPageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "SaleDiscountRights for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/SeqSaleDiscountRight" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Number of the requested page. In case state is lost", + "format": "int32", + "readOnly": true, + "example": 13 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "readOnly": true, + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "SaleDiscountRightPageWrapper" + }, + "SalesPackage": { + "required": [ + "accessRightParameterAssignments", + "changed", + "created", + "distributionAssignments", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "Access Right Parameter assignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active for this SP.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "SalesPackage changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "created": { + "type": "string", + "description": "SalesPackage create datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionAssignments": { + "type": "array", + "description": "Distribution assignments.", + "items": { + "$ref": "#/components/schemas/DistributionAssignment" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SalesPackage:Ordinary" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "SalesPackage Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "SalesPackage" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "salesPackageElements": { + "type": "array", + "description": "Sales package elements.", + "items": { + "$ref": "#/components/schemas/SalesPackageElement" + } + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is optional. No default value", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A SalesPackage response" + }, + "SalesPackageElement": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SalesPackageElement:Ordinary" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "SalesPackageElement" + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfTravelDocumentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A SalesPackageElement" + }, + "SalesPackageElementInsert": { + "required": [ + "fareFrameRef", + "fareTableRefs", + "id", + "name" + ], + "type": "object", + "properties": { + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SalesPackageElement:Ordinary" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "typeOfTravelDocumentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "SalesPackageInsert": { + "required": [ + "accessRightParameterAssignmentRefs", + "distributionAssignments", + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionAssignments": { + "type": "array", + "description": "Distribution assignments.", + "items": { + "$ref": "#/components/schemas/DistributionAssignmentInsert" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:UserProfile:Child" + }, + "name": { + "type": "array", + "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "salesPackageElements": { + "type": "array", + "description": "Sales package elements.", + "items": { + "$ref": "#/components/schemas/SalesPackageElementInsert" + } + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is optional. No default", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UserProfile version.", + "example": "NSB:Version:V1" + } + } + }, + "SalesPackagePageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "SalesPackages for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/v2.SalesPackage" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Number of the requested page. In case state is lost", + "format": "int32", + "readOnly": true, + "example": 13 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "readOnly": true, + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "SalesPackagePageWrapper" + }, + "ScopingValidityParameter": { + "required": [ + "changed", + "created", + "fareFrameRef", + "genericParameterAssignmentRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "authorityRef": { + "type": "string", + "description": "AuthorityRef.", + "example": "NSB:Authority:NSB" + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "distributionChannelRef": { + "type": "string", + "description": "Distribution channel ref.", + "example": "ENT:DistributionChannel:App" + }, + "facilitySetRef": { + "type": "string", + "description": "facilitySetRef." + }, + "fareClasses": { + "type": "array", + "description": "FareClasses. Enum as string with the following values: FIRST_CLASS, SECOND_CLASS, THIRD_CLASS, ECONOMY_CLASS, BUSINESS_CLASS, TURISTA, PREFERENTE, STANDARD_CLASS, PREMIUM_CLASS, ANY, UNKNOWN", + "items": { + "type": "string" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareSectionRef": { + "type": "string", + "description": "Fare section ref." + }, + "fareZoneRef": { + "type": "string", + "description": "FareZoneRef.", + "example": "KOL:FareZone:250" + }, + "genericParameterAssignmentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfLinesRef": { + "type": "string", + "description": "Group of Lines ref.", + "example": "ENT:GroupOfLines:AllLines" + }, + "groupOfTariffZonesRef": { + "type": "string", + "description": "Group of Tariff Zones ref.", + "example": "ENT:GroupOfTariffZones:AllZones" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ScopingValidityParameter:OperatorNSB" + }, + "lineRef": { + "type": "string", + "description": "LineRef." + }, + "lineType": { + "type": "string", + "description": "LineType.", + "example": "EXPRESS", + "enum": [ + "LOCAL", + "URBAN", + "LONG_DISTANCE", + "EXPRESS", + "SEASONAL", + "REPLACEMENT", + "FLEXIBLE", + "CORRIDOR_SERVICE", + "MAIN_ROUTE_WITH_FLEXIBLE_ENDS", + "FLEXIBLE_AREAS_ONLY", + "HAIL_AND_RIDE_SECTIONS", + "FIXED_STOP_AREA_WIDE", + "FREE_AREA_AREA_WIDE", + "MIXED_FLEXIBLE", + "MIXED_FLEXIBLE_AND_FIXED", + "FIXED", + "OTHER" + ] + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "ScopingValidityParameter" + }, + "operatorRef": { + "type": "string", + "description": "Operator referance." + }, + "placeUse": { + "type": "string", + "description": "PlaceUse", + "enum": [ + "START_AT", + "END_AT", + "VIA", + "RESTRICT_TO", + "OTHER" + ] + }, + "scheduledStopPointRef": { + "type": "string", + "description": "Scheduled stop Point ref." + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "tariffZoneRef": { + "type": "string", + "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef.", + "example": "RUT:TariffZone:2S", + "deprecated": true + }, + "topographicPlaceRef": { + "type": "string", + "description": "TopographicPlaceRef" + }, + "transportSubmode": { + "type": "string", + "description": "TransportSubmode.", + "example": "expressBus", + "enum": [ + "unknown", + "undefined", + "internationalFlight", + "domesticFlight", + "intercontinentalFlight", + "domesticScheduledFlight", + "shuttleFlight", + "intercontinentalCharterFlight", + "internationalCharterFlight", + "roundTripCharterFlight", + "sightseeingFlight", + "helicopterService", + "domesticCharterFlight", + "SchengenAreaFlight", + "airshipService", + "shortHaulInternationalFlight", + "canalBarge", + "localBus", + "regionalBus", + "expressBus", + "nightBus", + "postBus", + "specialNeedsBus", + "mobilityBus", + "mobilityBusForRegisteredDisabled", + "sightseeingBus", + "shuttleBus", + "highFrequencyBus", + "dedicatedLaneBus", + "schoolBus", + "schoolAndPublicServiceBus", + "railReplacementBus", + "demandAndResponseBus", + "airportLinkBus", + "internationalCoach", + "nationalCoach", + "shuttleCoach", + "regionalCoach", + "specialCoach", + "schoolCoach", + "sightseeingCoach", + "touristCoach", + "commuterCoach", + "funicular", + "streetCableCar", + "allFunicularServices", + "undefinedFunicular", + "metro", + "tube", + "urbanRailway", + "cityTram", + "localTram", + "regionalTram", + "sightseeingTram", + "shuttleTram", + "trainTram", + "telecabin", + "cableCar", + "lift", + "chairLift", + "dragLift", + "telecabinLink", + "local", + "highSpeedRail", + "suburbanRailway", + "regionalRail", + "interregionalRail", + "longDistance", + "international", + "sleeperRailService", + "nightRail", + "carTransportRailService", + "touristRailway", + "airportLinkRail", + "railShuttle", + "replacementRailService", + "specialTrain", + "crossCountryRail", + "rackAndPinionRailway", + "internationalCarFerry", + "nationalCarFerry", + "regionalCarFerry", + "localCarFerry", + "internationalPassengerFerry", + "nationalPassengerFerry", + "regionalPassengerFerry", + "localPassengerFerry", + "postBoat", + "trainFerry", + "roadFerryLink", + "airportBoatLink", + "highSpeedVehicleService", + "highSpeedPassengerService", + "sightseeingService", + "schoolBoat", + "cableFerry", + "riverBus", + "scheduledFerry", + "shuttleFerryService", + "communalTaxi", + "charterTaxi", + "waterTaxi", + "railTaxi", + "bikeTaxi", + "blackCab", + "miniCab", + "allTaxiServices", + "hireCar", + "hireVan", + "hireMotorbike", + "hireCycle", + "allHireVehicles" + ] + }, + "vehicleMode": { + "type": "string", + "description": "VehicleModeRef.", + "enum": [ + "AIR", + "BUS", + "COACH", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TAXI", + "TRAM", + "UNKNOWN" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A ScopingValidityParameter" + }, + "ScopingValidityParameterInsert": { + "required": [ + "id", + "version" + ], + "type": "object", + "properties": { + "authorityRef": { + "type": "string", + "description": "AuthorityRef.", + "example": "NSB:Authority:NSB" + }, + "changed": { + "type": "string", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "distributionChannelRef": { + "type": "string", + "description": "Reference to a DISTRIBUTION CHANNEL to which the ACCESS RIGHT PARAMETER ASSIGNMENTs applies.", + "example": "ENT:DistributionChannel:App" + }, + "facilitySetRef": { + "type": "string", + "description": "facilitySetRef." + }, + "fareClasses": { + "type": "array", + "description": "Fare class list.", + "items": { + "type": "string" + } + }, + "fareSectionRef": { + "type": "string", + "description": "Fare section ref." + }, + "fareZoneRef": { + "type": "string", + "description": "FareZoneRef.", + "example": "KOL:FareZone:250" + }, + "groupOfLinesRef": { + "type": "string", + "description": "Group of lines ref.", + "example": "ENT:GroupOfLines:AllLines" + }, + "groupOfTariffZonesRef": { + "type": "string", + "description": "Group of Tariff Zones ref", + "example": "ENT:GroupOfTariffZones:AllZones" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ScopingValidityParameter:OperatorNSB" + }, + "lineRef": { + "type": "string", + "description": "LineRef." + }, + "lineType": { + "type": "string", + "description": "LineType.", + "example": "EXPRESS", + "enum": [ + "LOCAL", + "URBAN", + "LONG_DISTANCE", + "EXPRESS", + "SEASONAL", + "REPLACEMENT", + "FLEXIBLE", + "CORRIDOR_SERVICE", + "MAIN_ROUTE_WITH_FLEXIBLE_ENDS", + "FLEXIBLE_AREAS_ONLY", + "HAIL_AND_RIDE_SECTIONS", + "FIXED_STOP_AREA_WIDE", + "FREE_AREA_AREA_WIDE", + "MIXED_FLEXIBLE", + "MIXED_FLEXIBLE_AND_FIXED", + "FIXED", + "OTHER" + ] + }, + "nameOfClass": { + "type": "string" + }, + "operatorRef": { + "type": "string", + "description": "Operator referance." + }, + "placeUse": { + "type": "string", + "description": "PlaceUse", + "enum": [ + "START_AT", + "END_AT", + "VIA", + "RESTRICT_TO", + "OTHER" + ] + }, + "scheduledStopPointRef": { + "type": "string", + "description": "Scheduled stop Point ref." + }, + "tariffZoneRef": { + "type": "string", + "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef", + "example": "RUT:TariffZone:2S", + "deprecated": true + }, + "topographicPlaceRef": { + "type": "string", + "description": "TopographicPlaceRef" + }, + "transportSubmode": { + "type": "string", + "description": "TransportSubmode.", + "example": "expressBus", + "enum": [ + "unknown", + "undefined", + "internationalFlight", + "domesticFlight", + "intercontinentalFlight", + "domesticScheduledFlight", + "shuttleFlight", + "intercontinentalCharterFlight", + "internationalCharterFlight", + "roundTripCharterFlight", + "sightseeingFlight", + "helicopterService", + "domesticCharterFlight", + "SchengenAreaFlight", + "airshipService", + "shortHaulInternationalFlight", + "canalBarge", + "localBus", + "regionalBus", + "expressBus", + "nightBus", + "postBus", + "specialNeedsBus", + "mobilityBus", + "mobilityBusForRegisteredDisabled", + "sightseeingBus", + "shuttleBus", + "highFrequencyBus", + "dedicatedLaneBus", + "schoolBus", + "schoolAndPublicServiceBus", + "railReplacementBus", + "demandAndResponseBus", + "airportLinkBus", + "internationalCoach", + "nationalCoach", + "shuttleCoach", + "regionalCoach", + "specialCoach", + "schoolCoach", + "sightseeingCoach", + "touristCoach", + "commuterCoach", + "funicular", + "streetCableCar", + "allFunicularServices", + "undefinedFunicular", + "metro", + "tube", + "urbanRailway", + "cityTram", + "localTram", + "regionalTram", + "sightseeingTram", + "shuttleTram", + "trainTram", + "telecabin", + "cableCar", + "lift", + "chairLift", + "dragLift", + "telecabinLink", + "local", + "highSpeedRail", + "suburbanRailway", + "regionalRail", + "interregionalRail", + "longDistance", + "international", + "sleeperRailService", + "nightRail", + "carTransportRailService", + "touristRailway", + "airportLinkRail", + "railShuttle", + "replacementRailService", + "specialTrain", + "crossCountryRail", + "rackAndPinionRailway", + "internationalCarFerry", + "nationalCarFerry", + "regionalCarFerry", + "localCarFerry", + "internationalPassengerFerry", + "nationalPassengerFerry", + "regionalPassengerFerry", + "localPassengerFerry", + "postBoat", + "trainFerry", + "roadFerryLink", + "airportBoatLink", + "highSpeedVehicleService", + "highSpeedPassengerService", + "sightseeingService", + "schoolBoat", + "cableFerry", + "riverBus", + "scheduledFerry", + "shuttleFerryService", + "communalTaxi", + "charterTaxi", + "waterTaxi", + "railTaxi", + "bikeTaxi", + "blackCab", + "miniCab", + "allTaxiServices", + "hireCar", + "hireVan", + "hireMotorbike", + "hireCycle", + "allHireVehicles" + ] + }, + "vehicleMode": { + "type": "string", + "description": "VehicleModeRef.", + "enum": [ + "AIR", + "BUS", + "COACH", + "CABLE_WAY", + "WATER", + "FUNICULAR", + "LIFT", + "RAIL", + "METRO", + "TAXI", + "TRAM", + "UNKNOWN" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A ScopingValidityParameter" + }, + "SecurityPolicy": { + "required": [ + "changed", + "created", + "id", + "minimumAccountSecurityLevel", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:SecurityPolicy:HighValueProduct" + }, + "minimumAccountSecurityLevel": { + "type": "integer", + "description": "Required (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "NameOfClass", + "readOnly": true, + "example": "SecurityPolicy" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "SeqExplainedMessageResponse": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + }, + "description": "Translated messages explaining the failure", + "readOnly": true + }, + "SeqGeographicalIntervalInsert": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "SeqSaleDiscountRight": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "SeqStatusFilterEnum": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "SeqUVPForNumberOfZonesInsert": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "SeqUsageValidityPeriodInsert": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "ServiceFacilitySet": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "accommodation": { + "$ref": "#/components/schemas/Accommodation" + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:ServiceFacilitySet:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "ServiceFacilitySet" + }, + "onboardStay": { + "$ref": "#/components/schemas/OnboardStay" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A ServiceFacilitySet" + }, + "SetString": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "traversableAgain": { + "type": "boolean" + } + } + }, + "SteppedDuration": { + "required": [ + "initialDuration", + "stepUnit", + "subsequentStepsDuration" + ], + "type": "object", + "properties": { + "initialDuration": { + "type": "string", + "description": "Initial duration. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "maximumDuration": { + "type": "string", + "description": "Maximum duration. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "stepUnit": { + "type": "string", + "description": "Step unit.", + "example": "ZONES", + "enum": [ + "STOPS", + "STOPS_INCLUDING_PASS_THROUGH_STOPS", + "SECTIONS", + "ZONES", + "NETWORKS", + "OPERATORS", + "COUNTRIES" + ] + }, + "subsequentStepsDuration": { + "type": "string", + "description": "Subsequent duration. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + } + }, + "description": "Stepped duration." + }, + "SupplementProduct": { + "required": [ + "accessRightParameterAssignments", + "accessRightsInProduct", + "changed", + "chargingMoment", + "created", + "fareFrameRef", + "fareProductRefs", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "organisation", + "pricingRuleRef", + "status", + "validityConditions", + "vatGroup", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "accessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "accessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "chargingMoment": { + "$ref": "#/components/schemas/ChargingMoment" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareProductRefs": { + "type": "array", + "description": "fareProductRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType", + "example": "POINT_TO_POINT_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "Reference to information about the fare.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SupplementProduct:BicycleReserving" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "SupplementProduct" + }, + "operatorRef": { + "type": "string", + "description": "The reference to the operator.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "type": "string", + "description": "Organisation." + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "pricingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "privateCode": { + "type": "string", + "description": "Privat code." + }, + "status": { + "type": "string", + "description": "Supplement product status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "supplementProductType": { + "type": "string", + "description": "The type of supplement product for which the supplement product belongs to.", + "enum": [ + "SEAT_RESERVATION", + "BICYCLE", + "DOG", + "ANIMAL", + "MEAL", + "WIFI", + "EXTRA_LUGGAGE", + "PENALTY", + "UPGRADE", + "JOURNEY_EXTENSION", + "JOURNEY_ADD_ON", + "EVENT_ADD_ON", + "PARKING" + ] + }, + "typeOfFareProduct": { + "$ref": "#/components/schemas/TypeOfFareProduct" + }, + "validityConditions": { + "type": "array", + "description": "validityConditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "vatGroup": { + "type": "string", + "description": "The VAT group for the SupplementProduct.", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Supplement product version.", + "example": "NSB:Version:V1" + } + }, + "description": "A SUPPLEMENT PRODUCT consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT and FARE PRODUCT" + }, + "SupplementProductInsert": { + "required": [ + "chargingMomentRef", + "fareFrameRef", + "id", + "name", + "operatorRef", + "organisation", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignmentRefs": { + "type": "array", + "description": "AccessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "AccessRightsInProduct.", + "items": { + "$ref": "#/components/schemas/AccessRightInProductInsert" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "chargingMomentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummaryInsert" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType.", + "example": "ZONE_TO_ZONE_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "FareTableRef.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SupplementProduct:LargeAnimal" + }, + "name": { + "type": "array", + "description": "Name.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "operatorRef": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "OperatorRef.", + "example": "RUT:Authority:RUT" + }, + "organisation": { + "minLength": 1, + "type": "string", + "description": "Organisation." + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "privateCode": { + "type": "string", + "description": "PrivateCode." + }, + "supplementProductType": { + "type": "string", + "description": "SupplementProductType.", + "example": "SEAT_RESERVATION", + "enum": [ + "SEAT_RESERVATION", + "BICYCLE", + "DOG", + "ANIMAL", + "MEAL", + "WIFI", + "EXTRA_LUGGAGE", + "PENALTY", + "UPGRADE", + "JOURNEY_EXTENSION", + "JOURNEY_ADD_ON", + "EVENT_ADD_ON", + "PARKING" + ] + }, + "typeOfFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT", + "default": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "Tariff": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Tariff:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Tariff Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "Tariff" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "returnFareTwiceSingle": { + "type": "boolean", + "description": "returnFareTwiceSingle" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "tariffBasis": { + "type": "string", + "description": "TariffBasis.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "validBetweenRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Tariffs version.", + "example": "NSB:Version:V1" + } + }, + "description": "A tariff" + }, + "TariffInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "validBetweenRef", + "version" + ], + "type": "object", + "properties": { + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:Tariff:Ordinary" + }, + "name": { + "type": "array", + "description": "Tariff Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "returnFareTwiceSingle": { + "type": "boolean", + "description": "returnFareTwiceSingle" + }, + "tariffBasis": { + "type": "string", + "description": "TariffBasis.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "validBetweenRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Tariff version.", + "example": "NSB:Version:V1" + } + } + }, + "TemporalValidityParameter": { + "required": [ + "changed", + "created", + "genericParameterAssignmentRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "CompatibleWithVersionRef" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "dayType": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "genericParameterAssignmentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfTimeBands": { + "$ref": "#/components/schemas/GroupOfTimeBands" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TemporalValidityParameter:OperatorNSB" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "TemporalValidityParameter" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityCondition": { + "$ref": "#/components/schemas/ValidityCondition" + }, + "validityConditionRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A TemporalValidityParameter" + }, + "TemporalValidityParameterInsert": { + "required": [ + "id", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "format": "date-time" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "dayType": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfTimeBands": { + "$ref": "#/components/schemas/GroupOfTimeBands" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TemporalValidityParameter:OperatorNSB" + }, + "nameOfClass": { + "type": "string" + }, + "validityCondition": { + "$ref": "#/components/schemas/ValidityCondition" + }, + "validityConditionRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "A TemporalValidityParameter" + }, + "TextInLanguage": { + "required": [ + "lang", + "value" + ], + "type": "object", + "properties": { + "lang": { + "minLength": 1, + "type": "string", + "description": "Language code.", + "example": "nob" + }, + "value": { + "minLength": 1, + "type": "string", + "description": "The text." + } + }, + "description": "Text in a specific language." + }, + "Timeband": { + "required": [ + "changed", + "created", + "dayOffset", + "description", + "endTime", + "fareFrameRef", + "id", + "modification", + "name", + "nameOfClass", + "startTime", + "status" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "dayOffset": { + "type": "integer", + "description": "Days offset. This will determine if endTime is x number of days from today. ie. 1 is tomorrow 0 is today.", + "format": "int32", + "example": 1 + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "endTime": { + "type": "string", + "description": "End time.", + "example": "11:11:11" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Timeband:2HoursValidPlus1" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "TimeBand" + }, + "startTime": { + "type": "string", + "description": "Start time.", + "example": "11:11:11" + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "timeZone": { + "type": "string", + "description": "Time zone.", + "example": "Europe/Oslo", + "default": "Europe/Oslo" + }, + "validityConditions": { + "type": "array", + "description": "ValidityConditions sequence.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "The TimeBand describe during which the assignment applies" + }, + "Transferability": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "canTransfer": { + "type": "boolean", + "description": "Whether ticket can be transferred to someone else.", + "example": false + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare tables.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "hasTransferFee": { + "type": "boolean", + "description": "Whether there is a charge for making a transfer.", + "example": false + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:Transferability:NoTransfer" + }, + "maximumNumberOfNamedUsers": { + "type": "integer", + "description": "Where a product can be used by a limited number of named users, maximum number of users allowed..", + "format": "int32" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "Transferability" + }, + "prices": { + "type": "array", + "description": "Prices in different currencies for the transferability rule.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Transferability version.", + "example": "NSB:Version:V1" + } + }, + "description": "Transferability" + }, + "TransferabilityAlternatives": { + "required": [ + "ref", + "transferabilityOptions" + ], + "type": "object", + "properties": { + "ref": { + "$ref": "#/components/schemas/IdAndVersion" + }, + "transferabilityOptions": { + "type": "array", + "description": "Transferability alternatives for this element.", + "items": { + "$ref": "#/components/schemas/Transferability" + } + } + }, + "description": "Transferability alternatives for an element." + }, + "TypeOfAccessRightAssignment": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "TypeOfAccessRightAssignment" + }, + "status": { + "type": "string", + "description": "Type of access right assignment status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Type of access right assignment version.", + "example": "NSB:Version:V1" + } + }, + "description": "A classification of Access Right Assignments." + }, + "TypeOfConcession": { + "required": [ + "changed", + "compatibleWithVersionRef", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "alternativeNames": { + "type": "string", + "description": "Alternative names for the type of concession" + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "TypeOfConcession description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TypeOfConcession:Student" + }, + "infolink": { + "type": "string", + "description": "An URL to more info about the type of concession" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "TypeOfConcession name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "TypeOfConcession" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "privateCode": { + "type": "string", + "description": "A code to support interoperability with legacy systems" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "TypeOfConcession version.", + "example": "NSB:Version:V1" + } + }, + "description": "A TypeOfConcession" + }, + "TypeOfConcessionInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "alternativeNames": { + "type": "string", + "description": "Alternative names for the type of concession" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "TypeOfConcession description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:TypeOfConcession:Student" + }, + "infolink": { + "type": "string", + "description": "An URL to more info about the type of concession" + }, + "name": { + "type": "array", + "description": "TypeOfConcession name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "privateCode": { + "type": "string", + "description": "A code to support interoperability with legacy systems" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "TypeOfConcession version.", + "example": "NSB:Version:V1" + } + }, + "description": "A TypeOfConcession" + }, + "TypeOfFareProduct": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "nameOfClass", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TypeOfFareProduct:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "TypeOfFareProduct" + }, + "status": { + "type": "string", + "description": "Type of fare product status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Type of fare product version.", + "example": "NSB:Version:V1" + } + }, + "description": "A classification of FARE PRODUCTs." + }, + "TypeOfFareProductInsert": { + "required": [ + "fareFrameRef", + "id" + ], + "type": "object", + "properties": { + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TypeOfFareProduct:Ordinary" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Type of fare product version.", + "example": "NSB:Version:V1" + } + } + }, + "TypeOfUsageParameter": { + "required": [ + "changed", + "compatibleWithVersionRef", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TypeOfUsageParameter:abc123" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "TypeOfUsageParameter" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "TypeOfUsageParameterInsert": { + "required": [ + "fareFrameRef", + "id", + "version" + ], + "type": "object", + "properties": { + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:TypeOfUsageParameter:ThroughFareInterchanging" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + } + }, + "UVPForNumberOfZones": { + "required": [ + "authorityId", + "fareFrameRef", + "id", + "nameOfClass", + "numberOfZones", + "status", + "usageValidityPeriodId", + "version" + ], + "type": "object", + "properties": { + "authorityId": { + "type": "string", + "description": "Reference to authority.", + "example": "RUT:Authority:RUT" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:UVPForNumberOfZones:example" + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "UVPForNumberOfZones" + }, + "numberOfZones": { + "type": "integer", + "description": "Number of zones.", + "format": "int64", + "example": 3 + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "usageValidityPeriodId": { + "type": "string", + "description": "Reference to usage validity period.", + "example": "NSB:UsageValidityPeriod:Child" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + }, + "zoneRange": { + "type": "string", + "description": "Zone range.", + "example": "4:9" + } + } + }, + "UVPForNumberOfZonesInsert": { + "required": [ + "authorityId", + "fareFrameRef", + "id", + "numberOfZones", + "usageValidityPeriodId" + ], + "type": "object", + "properties": { + "authorityId": { + "type": "string", + "description": "Reference to authority.", + "example": "RUT:Authority:RUT" + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:UVPForNumberOFZones:123" + }, + "numberOfZones": { + "type": "integer", + "description": "Number of zones.", + "format": "int64", + "example": 3 + }, + "usageValidityPeriodId": { + "type": "string", + "description": "Reference to usage validity period.", + "example": "NSB:UsageValidityPeriod:Child" + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + }, + "zoneRange": { + "type": "string", + "description": "Zone range.", + "example": "4:9" + } + } + }, + "UsageValidityPeriod": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "activationMeans": { + "type": "array", + "description": "Activation Means. Describes how a product can be activated.", + "items": { + "type": "string" + } + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to FareTable.", + "items": { + "$ref": "#/components/schemas/FareTableRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:UsageValidityPeriod:Child" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/LimitingRule" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "UsageValidityPeriod" + }, + "standardDuration": { + "type": "string", + "description": "Standard duration. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "steppedDuration": { + "$ref": "#/components/schemas/SteppedDuration" + }, + "usageEnd": { + "type": "string", + "description": "Usage end.", + "enum": [ + "STANDARD_DURATION", + "END_OF_CALENDAR_PERIOD", + "END_OF_RIDE", + "END_OF_TRIP", + "END_OF_FARE_DAY", + "END_OF_FARE_PERIOD", + "PRODUCT_EXPIRY", + "PROFILE_EXPIRY", + "DEREGISTRATION", + "UOTHER" + ] + }, + "usageEnds": { + "type": "array", + "description": "Usage ends. This field is deprecated, please use the field usageEnd", + "deprecated": true, + "items": { + "type": "string" + } + }, + "usageStartConstraintType": { + "type": "string", + "description": "Usage start constraint.", + "enum": [ + "VARIABLE", + "FIXED", + "FIXED_WINDOW" + ] + }, + "usageTrigger": { + "type": "string", + "description": "Usage trigger.", + "enum": [ + "START_OF_PERIOD", + "START_OUT_BOUND_RIDE", + "END_OUT_BOUND_RIDE", + "START_RETURN_RIDE", + "PURCHASE", + "SPECIFIED_START_DATE", + "FULFILMENT", + "DAY_OFFSET_BEFORE_CALENDAR_PERIOD" + ] + }, + "usageValidityType": { + "type": "string", + "description": "Usage validity type.", + "enum": [ + "SINGLE_RIDE", + "SINGLE_TRIP", + "RETURN_TRIP", + "CARNET", + "DAY_PASS", + "WEEKLY_PASS", + "WEEKEND_PASS", + "MONTHLY_PASS", + "SEASON_TICKET", + "PROFILE_MEMBERSHIP", + "OPEN_ENDED", + "OTHER" + ] + }, + "usageValidityTypes": { + "type": "array", + "description": "Usage validity type list.", + "items": { + "type": "string" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UsageValidityPeriod version.", + "example": "NSB:Version:V1" + } + }, + "description": "A UsageValidityPeriod response" + }, + "UsageValidityPeriodInsert": { + "required": [ + "fareFrameRef", + "fareTableRefs", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "activationMeans": { + "type": "array", + "description": "Activation Means. Describes how a product can be activated.", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to FareTable.", + "items": { + "$ref": "#/components/schemas/FareTableRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:UsageValidityPeriod:30Days" + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "standardDuration": { + "type": "string", + "description": "Standard duration. Represented as a string formatted according to ISO-8601", + "example": "PT1H" + }, + "steppedDuration": { + "$ref": "#/components/schemas/SteppedDuration" + }, + "usageEnd": { + "type": "string", + "description": "Usage end.", + "enum": [ + "STANDARD_DURATION", + "END_OF_CALENDAR_PERIOD", + "END_OF_RIDE", + "END_OF_TRIP", + "END_OF_FARE_DAY", + "END_OF_FARE_PERIOD", + "PRODUCT_EXPIRY", + "PROFILE_EXPIRY", + "UOTHER" + ] + }, + "usageEnds": { + "type": "array", + "description": "Usage End list.", + "items": { + "type": "string" + } + }, + "usageStartConstraintType": { + "type": "string", + "description": "Usage start constraint.", + "enum": [ + "VARIABLE", + "FIXED", + "FIXED_WINDOW" + ] + }, + "usageTrigger": { + "type": "string", + "description": "Usage trigger.", + "enum": [ + "START_OF_PERIOD", + "START_OUT_BOUND_RIDE", + "END_OUT_BOUND_RIDE", + "START_RETURN_RIDE", + "PURCHASE", + "SPECIFIED_START_DATE", + "FULFILMENT", + "DAY_OFFSET_BEFORE_CALENDAR_PERIOD" + ] + }, + "usageValidityTypes": { + "type": "array", + "description": "Usage validity type list.", + "items": { + "type": "string" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UsageValidityPeriod version.", + "example": "NSB:Version:V1" + } + } + }, + "UserProfile": { + "required": [ + "changed", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "baseUserProfileRef": { + "type": "string", + "description": "The id of the base user profile which this profile is a specialization of." + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "format": "date-time" + }, + "companionProfiles": { + "type": "array", + "description": "Companion Profiles in Group Ticket", + "items": { + "$ref": "#/components/schemas/CompanionProfile" + } + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "format": "date-time" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the user profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:UserProfile:Child" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "maxAge": { + "type": "string", + "description": "Maximum age.", + "example": "16" + }, + "minAge": { + "type": "string", + "description": "Minimum age.", + "example": "4" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "UserProfile" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile", + "readOnly": true + }, + "prices": { + "type": "array", + "description": "Fare prices for the user profile.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "proofOfIdentity": { + "type": "string", + "description": "proofOfIdentity.", + "enum": [ + "NONE_REQUIRED", + "PASSPORT", + "DRIVERS_LICENCE", + "IDENTITY_DOCUMENT", + "CREDIT_CARD", + "MEMBERSHIP_CARD", + "STUDENT_CARD", + "LETTER_WITH_ADDRESS", + "MEDICAL_DOCUMENT", + "MEASUREMENT", + "OTHER" + ] + }, + "status": { + "type": "string", + "description": "Status", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "typeOfConcessionRef": { + "type": "string", + "description": "typeOfConcessionRef." + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "userType": { + "type": "string", + "description": "UserType.", + "example": "CHILD", + "enum": [ + "ANYONE", + "ADULT", + "CHILD", + "INFANT", + "ANIMAL", + "SENIOR", + "GUIDE_DOG", + "YOUTH", + "STUDENT", + "MILITARY" + ] + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UserProfile version.", + "example": "NSB:Version:V1" + } + }, + "description": "A UserProfile" + }, + "UserProfileInsert": { + "required": [ + "fareFrameRef", + "id", + "name", + "proofOfIdentity", + "version" + ], + "type": "object", + "properties": { + "baseUserProfileRef": { + "type": "string", + "description": "The id of the base user profile which this profile is a specialization of." + }, + "companionProfileIds": { + "type": "array", + "description": "Companion profiles describing users who may travel with user.", + "deprecated": true, + "items": { + "type": "string" + } + }, + "companionProfiles": { + "type": "array", + "description": "Companion profiles describing users who may travel with user.", + "items": { + "$ref": "#/components/schemas/CompanionProfileInject" + } + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version.", + "example": "NSB:Version:V1" + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version.", + "example": "NSB:Version:V1" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the user profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:UserProfile:Child" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "maxAge": { + "type": "integer", + "description": "Maximum age.", + "format": "int32", + "example": 16 + }, + "minAge": { + "type": "integer", + "description": "Minimum age.", + "format": "int32", + "example": 4 + }, + "name": { + "type": "array", + "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices for the user profile.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "proofOfIdentity": { + "type": "string", + "description": "proofOfIdentity.", + "enum": [ + "NONE_REQUIRED", + "PASSPORT", + "DRIVERS_LICENCE", + "IDENTITY_DOCUMENT", + "CREDIT_CARD", + "MEMBERSHIP_CARD", + "STUDENT_CARD", + "LETTER_WITH_ADDRESS", + "MEDICAL_DOCUMENT", + "MEASUREMENT", + "OTHER" + ] + }, + "typeOfConcessionRef": { + "type": "string", + "description": "typeOfConcessionRef." + }, + "typeOfUsageParameter": { + "type": "string", + "description": "typeOfUsageParameter." + }, + "userType": { + "type": "string", + "description": "UserType.", + "example": "CHILD", + "enum": [ + "ANYONE", + "ADULT", + "CHILD", + "INFANT", + "ANIMAL", + "SENIOR", + "GUIDE_DOG", + "YOUTH", + "STUDENT", + "MILITARY" + ] + }, + "validityConditions": { + "type": "array", + "description": "Validity conditions for the user profile.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "UserProfile version.", + "example": "NSB:Version:V1" + } + }, + "description": "A UserProfile create request" + }, + "ValidBetween": { + "required": [ + "changed", + "created", + "fareFrameRef", + "fromDate", + "id", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description of ValidBetween represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fromDate": { + "type": "string", + "description": "From Date." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ValidBetween:2018" + }, + "name": { + "type": "array", + "description": "Name of ValidBetween represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "ValidBetween" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "toDate": { + "type": "string", + "description": "To Date." + }, + "validityConditions": { + "type": "array", + "description": "List of validityConditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A ValidBetween" + }, + "ValidBetweenInsert": { + "required": [ + "fareFrameRef", + "fromDate", + "id" + ], + "type": "object", + "properties": { + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fromDate": { + "type": "string", + "description": "From Date.", + "example": "2017-07-21T17:32:28Z" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ValidBetween:2018" + }, + "toDate": { + "type": "string", + "description": "To Date.", + "example": "2017-07-21T17:32:28Z" + }, + "validityConditions": { + "type": "array", + "description": "List of validityConditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A ValidBetween create request" + }, + "ValidableElement": { + "required": [ + "accessRightParameterAssignments", + "changed", + "created", + "fareFrameRef", + "fareTableRefs", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "The references to access right parameter assignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "areaValidity": { + "$ref": "#/components/schemas/AreaValidity" + }, + "changed": { + "type": "string", + "description": "Changed datetime." + }, + "compatibleWithVersionRef": { + "type": "string", + "description": "Compatible with version." + }, + "created": { + "type": "string", + "description": "Created datetime." + }, + "derivedFromVersionRef": { + "type": "string", + "description": "Derived from version." + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementsInSequence": { + "type": "array", + "description": "The fare structure elements in sequence", + "items": { + "$ref": "#/components/schemas/FareStructureElementInSequence" + } + }, + "fareStructureElementsRef": { + "type": "array", + "description": "The reference to the fare divided into a sequence.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "fareTableRefs": { + "type": "array", + "description": "References for associated fare table.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ValidableElement:Ordinary" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "example": "ValidableElement" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "pricingRuleRef": { + "type": "string", + "description": "Pricing rule reference.", + "example": "unused" + }, + "status": { + "type": "string", + "description": "Status.", + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityConditions": { + "type": "array", + "description": "Gives a sequence of conditions for validity.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Validable element version.", + "example": "NSB:Version:V1" + } + }, + "description": "A ValidationElement" + }, + "ValidableElementInsert": { + "required": [ + "description", + "fareFrameRef", + "id", + "name", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "The references to access right parameter assignments.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "areaValidity": { + "$ref": "#/components/schemas/AreaValidity" + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureElementsInSequence": { + "type": "array", + "description": "Fare structure elements in sequence", + "items": { + "$ref": "#/components/schemas/FareStructureElementInSequenceInsert" + } + }, + "fareStructureElementsRef": { + "type": "array", + "description": "The reference to the fare divided into a sequence.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "fareTableRefs": { + "type": "array", + "description": "References to fare tables that provide prices or discounts for the user profile.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:ValidableElement:Child" + }, + "name": { + "type": "array", + "description": "ValidableElement Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePriceInsert" + } + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "ValidableElement version.", + "example": "NSB:Version:V1" + } + } + }, + "ValidableElementPageWrapper": { + "required": [ + "items", + "requestedPageNumber", + "totalNumberOfItems", + "totalNumberOfPages" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "description": "Validable elements for the given page", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/ValidableElement" + } + }, + "requestedPageNumber": { + "type": "integer", + "description": "Number of the requested page. In case state is lost", + "format": "int32", + "example": 1 + }, + "totalNumberOfItems": { + "type": "integer", + "description": "Total number of items.", + "format": "int32", + "example": 369 + }, + "totalNumberOfPages": { + "type": "integer", + "description": "Number of pages needed to traverse all items.", + "format": "int32", + "readOnly": true, + "example": 15 + } + }, + "description": "Validable Element Page Wrapper" + }, + "ValidityCondition": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "version" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "fromDate": { + "type": "string", + "description": "From Date." + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:ValidBetween:2018" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "ValidBetween" + }, + "status": { + "type": "string", + "description": "Status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "toDate": { + "type": "string", + "description": "To Date." + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version.", + "example": "NSB:Version:V1" + } + }, + "description": "A condition of the validity of the priceable object" + }, + "VatRegister": { + "required": [ + "description", + "id", + "validFrom", + "vatGroup", + "vatRate" + ], + "type": "object", + "properties": { + "arrivalCountryCode": { + "type": "string", + "description": "Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3", + "example": "NOR" + }, + "countryCode": { + "type": "string", + "description": "Country for which the VAT is valid, based on ISO 3166-1 alfa-3", + "example": "NOR" + }, + "departureCountryCode": { + "type": "string", + "description": "Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3", + "example": "NOR" + }, + "description": { + "minLength": 1, + "type": "string", + "description": "The VAT description", + "example": "Person transport and tickets in Norway" + }, + "id": { + "minLength": 1, + "type": "string", + "description": "Id.", + "example": "ENT:VatRegister:SomeId" + }, + "organisationId": { + "type": "integer", + "description": "OrganisationId for the organisation who uses this VAT-specification.", + "format": "int64" + }, + "validFrom": { + "minLength": 1, + "type": "string", + "description": "The time and date from which the VAT is valid" + }, + "validTo": { + "type": "string", + "description": "The time and date to which the VAT is valid" + }, + "vatCode": { + "type": "string", + "description": "Code for the VAT, used for accounting", + "example": "33" + }, + "vatGroup": { + "type": "string", + "description": "VAT group", + "example": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "vatRate": { + "minLength": 1, + "type": "string", + "description": "The percentage rate for the VAT", + "example": "12.0" + } + }, + "description": "A case class for vat register." + }, + "Version": { + "required": [ + "changed", + "created", + "id", + "modification", + "nameOfClass", + "status", + "versionType" + ], + "type": "object", + "properties": { + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description." + }, + "endDate": { + "type": "string", + "description": "EndDate", + "format": "date-time" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "RUT:Version:RuterSingleTicket" + }, + "modification": { + "type": "string", + "description": "Modification status", + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "Version" + }, + "startDate": { + "type": "string", + "description": "StartDate", + "format": "date-time" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "default": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "versionType": { + "type": "string", + "description": "VersionType.", + "enum": [ + "BASELINE", + "POINT" + ] + } + }, + "description": "A case class for versioning." + }, + "VersionBatchRetrieve": { + "required": [ + "entityIds" + ], + "type": "object", + "properties": { + "entityIds": { + "type": "array", + "description": "entityIds", + "example": [ + "ENT:PreassignedFareProduct:abc123", + "ENT:PreassignedFareProduct:123abc" + ], + "items": { + "type": "string" + } + } + }, + "description": "A case class for versioning." + }, + "VersionOfObjectRef": { + "required": [ + "nameOfClass", + "ref", + "version" + ], + "type": "object", + "properties": { + "nameOfClass": { + "minLength": 1, + "type": "string", + "description": "Name of class." + }, + "ref": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "The netex id reference to the object." + }, + "version": { + "type": "string", + "description": "Version." + } + }, + "description": "Fare frame ref." + }, + "v2.DistributionAssignment": { + "required": [ + "allDistributionChannelsRef", + "changed", + "created", + "distributionRights", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "organisationRef", + "paymentMethods", + "salesPackageRef", + "status", + "version" + ], + "type": "object", + "properties": { + "allDistributionChannelsRef": { + "type": "boolean", + "description": "Flag for distribution in all channels." + }, + "allOrganisationRef": { + "type": "boolean", + "description": "Flag for all organisations." + }, + "allowedInChannel": { + "type": "boolean", + "description": "Flag for allowed in channel." + }, + "allowedInCountry": { + "type": "boolean", + "description": "Flag for allowed in country." + }, + "anyCountryRef": { + "type": "boolean", + "description": "Flag for allowed in any country." + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "countryRef": { + "type": "string", + "description": "Country reference." + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionChannelRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "distributionChannelType": { + "type": "string", + "description": "Type of distribution channel.", + "enum": [ + "AT_STOP", + "ON_BOARD", + "ONLINE", + "TELEPHONE", + "ELECTRONIC_PASS", + "MOBILE_DEVICE", + "AGENCY", + "TOUR_OPERATOR", + "OTHER" + ] + }, + "distributionRights": { + "type": "string", + "description": "Distribution rights.", + "example": "SELL", + "enum": [ + "NONE", + "SELL", + "REFUND", + "EXCHANGE", + "INFROM", + "PRIVATE", + "OTHER" + ] + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "finalCarrier": { + "type": "boolean", + "description": "Flag for final carrier." + }, + "fulfilmentMethodRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfDistributionChannelsRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "groupOfSalesPackagesRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:DistributionAssignment:Ordinary" + }, + "initialCarrier": { + "type": "boolean", + "description": "Flag for initial carrier." + }, + "mandatoryProduct": { + "type": "boolean", + "description": "Flag for mandatory product." + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "The name of the distribution assignment represented in different languages. Language codes are ISO-639", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "DistributionAssignment" + }, + "organisationRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "paymentMethods": { + "type": "array", + "description": "Payment methods.", + "items": { + "type": "string", + "example": "CREDIT_CARD", + "enum": [ + "CASH", + "CASH_AND_CARD", + "COIN", + "BANKNOTE", + "CREDIT_CARD", + "DEBIT_CARD", + "CONTACTLESS_PAYMENT_CARD", + "CARDS_ONLY", + "TRAVEL_CARD", + "CONTACTLESS_TRAVEL_CARD", + "SMS", + "MOBILE_PHONE", + "CHEQUE", + "COMPANY_CHEQUE", + "TRAVELLERS_CHEQUE", + "POSTAL_ORDER", + "VOUCHER", + "TOKEN", + "WARRANT", + "OTHER" + ] + } + }, + "requiresRegistration": { + "type": "boolean", + "description": "Flag for requires registration." + }, + "responsibilitySetRef": { + "type": "string", + "description": "Responsibility set reference." + }, + "restrictedToChannel": { + "type": "boolean", + "description": "Flag for restricted to channel." + }, + "salesPackageRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "serviceAccessRightRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "ticketingServices": { + "type": "array", + "description": "Ticketing services.", + "items": { + "type": "string", + "enum": [ + "TSF_PURCHASE", + "COLLECTION", + "CARD_TOP_UP", + "RESERVATIONS" + ] + } + }, + "topographicPlaceRef": { + "type": "string", + "description": "Topographical place reference." + }, + "transitCarrier": { + "type": "boolean", + "description": "Flag for transit carrier." + }, + "version": { + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + } + }, + "v2.SalesPackage": { + "required": [ + "changed", + "created", + "distributionAssignments", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "status", + "validityParameterAssignments", + "version" + ], + "type": "object", + "properties": { + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active for this SP.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "Changed datetime", + "readOnly": true + }, + "created": { + "type": "string", + "description": "Created datetime", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "distributionAssignments": { + "type": "array", + "description": "Distribution assignments.", + "items": { + "$ref": "#/components/schemas/v2.DistributionAssignment" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id", + "example": "NSB:SalesPackage:Ordinary" + }, + "limitingRule": { + "$ref": "#/components/schemas/LimitingRule" + }, + "limitingRuleRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "modification": { + "type": "string", + "description": "Modification status", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class", + "readOnly": true, + "example": "SalesPackage" + }, + "organisationId": { + "type": "string", + "description": "Organisation related to the userProfile" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "salesPackageElements": { + "type": "array", + "description": "Sales package elements.", + "items": { + "$ref": "#/components/schemas/SalesPackageElement" + } + }, + "status": { + "type": "string", + "description": "Status", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "validityParameterAssignments": { + "type": "array", + "description": "Validity Parameter assignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "vatGroupRegister": { + "type": "string", + "description": "VatGroupRegister is optional. No default value", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Version", + "example": "NSB:Version:V1" + } + }, + "description": "SalesPackage" + }, + "v2.SupplementProduct": { + "required": [ + "changed", + "chargingMomentRef", + "created", + "fareFrameRef", + "id", + "modification", + "nameOfClass", + "operatorRef", + "organisationRef", + "status", + "version" + ], + "type": "object", + "properties": { + "accessRightParameterAssignments": { + "type": "array", + "description": "accessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/GenericParameterAssignment" + } + }, + "accessRightsInProduct": { + "type": "array", + "description": "accessRightParameterAssignments.", + "items": { + "$ref": "#/components/schemas/AccessRightInProduct" + } + }, + "activeComparisonOperatorVariant": { + "type": "string", + "description": "Indicates whether A or E gpa implementation is active.", + "example": "A" + }, + "changed": { + "type": "string", + "description": "Changed datetime.", + "readOnly": true + }, + "chargingMomentRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "chargingMomentType": { + "type": "string", + "description": "ChargingMomentType.", + "example": "BEFORE_TRAVEL", + "enum": [ + "BEFORE_TRAVEL", + "ON_START_OF_TRAVEL", + "BEFORE_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", + "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", + "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", + "AT_END_OF_TRAVEL", + "AT_END_OF_CHARGE_PERIOD", + "FREE", + "ANY_TIME", + "OTHER" + ] + }, + "conditionSummary": { + "$ref": "#/components/schemas/ConditionSummary" + }, + "created": { + "type": "string", + "description": "Created datetime.", + "readOnly": true + }, + "description": { + "type": "array", + "description": "Description represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "fareFrameRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "fareStructureType": { + "type": "string", + "description": "FareStructureType", + "example": "POINT_TO_POINT_FARE", + "enum": [ + "CAPPED_FLAT_FARE", + "CAPPED_POINT_TO_POINT_FARE", + "CAPPED_ZONAL_FARE", + "LINE_FLAT_FARE", + "NETWORK_FLAT_FARE", + "POINT_TO_POINT_FARE", + "POINT_TO_POINT_DISTANCE_FARE", + "STAGE_FARE", + "ZONE_FLAT_FARE", + "ZONE_SEQUENCE_FARE", + "ZONE_TO_ZONE_FARE", + "ZONE_COUNT_FARE", + "PENALTY_FARE", + "OTHER" + ] + }, + "fareTableRefs": { + "type": "array", + "description": "Reference to information about the fare.", + "items": { + "$ref": "#/components/schemas/VersionOfObjectRef" + } + }, + "id": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Id.", + "example": "NSB:SupplementProduct:BicycleReserving" + }, + "modification": { + "type": "string", + "description": "Modification status.", + "readOnly": true, + "example": "NEW", + "enum": [ + "NEW", + "REVISE", + "DELETE" + ] + }, + "name": { + "type": "array", + "description": "Name represented in different languages. Language codes are ISO-639.", + "items": { + "$ref": "#/components/schemas/TextInLanguage" + } + }, + "nameOfClass": { + "type": "string", + "description": "Name of class.", + "readOnly": true, + "example": "SupplementProduct" + }, + "operatorRef": { + "type": "string", + "description": "The reference to the operator.", + "example": "RUT:Authority:RUT" + }, + "organisationRef": { + "type": "string", + "description": "The reference to the organisation.", + "example": "ENT:Authority:ENT" + }, + "prices": { + "type": "array", + "description": "Fare prices.", + "items": { + "$ref": "#/components/schemas/FarePrice" + } + }, + "privateCode": { + "type": "string", + "description": "Privat code." + }, + "status": { + "type": "string", + "description": "Supplement product status.", + "readOnly": true, + "example": "DRAFT", + "enum": [ + "DRAFT", + "PROPOSED", + "VERSIONED", + "DEPRECATED" + ] + }, + "supplementProductType": { + "type": "string", + "description": "The type of supplement product for which the supplement product belongs to.", + "enum": [ + "SEAT_RESERVATION", + "BICYCLE", + "DOG", + "ANIMAL", + "MEAL", + "WIFI", + "EXTRA_LUGGAGE", + "PENALTY", + "UPGRADE", + "JOURNEY_EXTENSION", + "JOURNEY_ADD_ON", + "EVENT_ADD_ON", + "PARKING", + "TOP_UP", + "OTHER" + ] + }, + "typeOfFareProductRef": { + "$ref": "#/components/schemas/VersionOfObjectRef" + }, + "validityConditions": { + "type": "array", + "description": "validityConditions.", + "items": { + "$ref": "#/components/schemas/ValidityCondition" + } + }, + "vatGroupRegister": { + "type": "string", + "description": "The VAT group for the SupplementProduct.", + "default": "TRANSPORT_AND_TICKETS_VAT", + "enum": [ + "EXCEPTION_FROM_VAT", + "GENERAL_VAT", + "FOOD_VAT", + "TRANSPORT_AND_TICKETS_VAT" + ] + }, + "version": { + "minLength": 1, + "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", + "type": "string", + "description": "Supplement product version.", + "example": "NSB:Version:V1" + } + }, + "description": "A Supplement product consisting of one or several validable elements, specific to a charging moment and fare product" + } + }, + "securitySchemes": { + "jwt": { + "bearerFormat": "JWT", + "scheme": "bearer", + "type": "http" + } + } + } +} \ No newline at end of file From 9f9f3ede4d2914d7dfee5199d3fba054caccdb05 Mon Sep 17 00:00:00 2001 From: rikard Date: Tue, 21 Apr 2026 11:13:12 +0200 Subject: [PATCH 2/5] fix: ETU-67083: Truncating $GITHUB_STEP_SUMMARY when it becomes larger than 1024Kb --- .github/workflows/lint.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f5b2718..964c6e6 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -131,7 +131,14 @@ jobs: if [ "$rc" -eq 1 ]; then cat $annotations - cat $markdown >> $GITHUB_STEP_SUMMARY + # Truncate to stay under GitHub's 1024k step summary limit + max_size=$((1000 * 1024)) + if [ "$(wc -c < "$markdown")" -gt "$max_size" ]; then + head -c "$max_size" "$markdown" >> $GITHUB_STEP_SUMMARY + echo -e "\n\n> **Warning:** Summary was truncated because it exceeded the 1024k size limit." >> $GITHUB_STEP_SUMMARY + else + cat $markdown >> $GITHUB_STEP_SUMMARY + fi echo if [ "$GHA_API_FAIL_THRESHOLD" != "never" ]; then From df4d67be2830d024258f11e7300d033ad6415998 Mon Sep 17 00:00:00 2001 From: rikard Date: Tue, 21 Apr 2026 11:18:13 +0200 Subject: [PATCH 3/5] fix: ETU-67083: Truncating $GITHUB_STEP_SUMMARY when it becomes larger than 1024Kb --- .github/workflows/lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 964c6e6..319ee76 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -132,7 +132,7 @@ jobs: if [ "$rc" -eq 1 ]; then cat $annotations # Truncate to stay under GitHub's 1024k step summary limit - max_size=$((1000 * 1024)) + max_size=$((1024 * 1024 - 200)) if [ "$(wc -c < "$markdown")" -gt "$max_size" ]; then head -c "$max_size" "$markdown" >> $GITHUB_STEP_SUMMARY echo -e "\n\n> **Warning:** Summary was truncated because it exceeded the 1024k size limit." >> $GITHUB_STEP_SUMMARY From 002ce46b507c000feb4fd3ab7e4b9cc706ccf7f1 Mon Sep 17 00:00:00 2001 From: rikard Date: Tue, 21 Apr 2026 11:21:53 +0200 Subject: [PATCH 4/5] fix: ETU-67083: Truncating $GITHUB_STEP_SUMMARY when it becomes larger than 1024Kb --- .github/workflows/lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 319ee76..0d893aa 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -131,7 +131,7 @@ jobs: if [ "$rc" -eq 1 ]; then cat $annotations - # Truncate to stay under GitHub's 1024k step summary limit + # Truncate to stay under GitHub's 1024k step summary limit. Leave 200 bytes for warning message. max_size=$((1024 * 1024 - 200)) if [ "$(wc -c < "$markdown")" -gt "$max_size" ]; then head -c "$max_size" "$markdown" >> $GITHUB_STEP_SUMMARY From 36910c178d437980cd19c53b8eaac9b1e032b6ff Mon Sep 17 00:00:00 2001 From: rikard Date: Tue, 21 Apr 2026 11:22:09 +0200 Subject: [PATCH 5/5] Revert "fix: ETU-67083: Testing lint of big spec" This reverts commit cfd19d22cbc139a9efc1c718cef8caf23439a938. --- .github/workflows/ci.yml | 9 +- fixture/openapi-big.json | 61080 ------------------------------------- 2 files changed, 1 insertion(+), 61088 deletions(-) delete mode 100644 fixture/openapi-big.json diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f6324b1..a8b712b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -87,11 +87,4 @@ jobs: uses: ./.github/workflows/validate.yml with: artifact: "specs" - path: "openapi-good.json" - - test-lint-big: - uses: ./.github/workflows/lint.yml - with: - path: fixture/openapi-big.json - upload_to_bucket: false - fail_threshold: error \ No newline at end of file + path: "openapi-good.json" \ No newline at end of file diff --git a/fixture/openapi-big.json b/fixture/openapi-big.json deleted file mode 100644 index bdf66ad..0000000 --- a/fixture/openapi-big.json +++ /dev/null @@ -1,61080 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "description": "This API provides services to read and maintain products and fare data for public transport in Norway.", - "title": "Products", - "version": "0.0.1", - "x-entur-metadata": { - "audience": "partner", - "id": "products", - "owner": "team-produkt" - } - }, - "servers": [ - { - "url": "https://api.entur.io/products", - "description": "Production environment" - }, - { - "url": "https://api.staging.entur.io/products", - "description": "Staging environment" - }, - { - "url": "https://api.dev.entur.io/products", - "description": "Development environment" - } - ], - "security": [ - { - "jwt": [] - } - ], - "tags": [ - { - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "name": "supplement-products" - } - ], - "paths": { - "/admin/bucket-invalidation": { - "post": { - "operationId": "admin/bucket-invalidation_invalidateAll", - "responses": { - "202": { - "description": "Invalidation started" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Invalidate and rebuild GCS buckets for all entity types", - "tags": [ - "admin/bucket-invalidation" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/bucket-invalidation/{entityType}": { - "post": { - "operationId": "admin/bucket-invalidation_invalidateEntityType", - "parameters": [ - { - "description": "Entity type: SalesPackage, FarePrice, FareTable, SaleDiscountRight, or UserProfile", - "in": "path", - "name": "entityType", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Invalidation started" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Invalid entity type" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Invalidate and rebuild GCS bucket for a specific entity type", - "tags": [ - "admin/bucket-invalidation" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/delete": { - "put": { - "operationId": "admin/cache_deleteEntityByObject", - "parameters": [ - { - "description": "Specify this if you want to delete all elements connected to a specific type of entity. I.e. \u0027fare_structure_element\u0027 or \u0027fare_table\u0027 etc.", - "in": "query", - "name": "nameOfEntity", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "integer", - "format": "int64" - } - } - }, - "description": "Successfully deleted" - }, - "204": { - "content": { - "*/*": { - "schema": { - "type": "integer", - "format": "int64" - } - } - }, - "description": "No content. Deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete all elements in cache or delete specific element given key in req.body", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/delete/all": { - "put": { - "operationId": "admin/cache_deleteAllEntitiesFromCache", - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - }, - "description": "Successfully deleted" - }, - "204": { - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - }, - "description": "No content. Deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete all elements in cache", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/invalidate": { - "put": { - "operationId": "admin/cache_invalidateCache", - "parameters": [ - { - "description": "Specify this if you want to invalidate cache for elements connected to a specific type of entity. I.e. \u0027fare_structure_element\u0027 or \u0027fare_table\u0027 etc. . If no value given all cache will be invalidated", - "in": "query", - "name": "nameOfEntity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "If set to true the whole cache will be invalidated. If false only the cache for the specified entity will be invalidated. Default is false.", - "in": "query", - "name": "all", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - }, - "description": "Successfully deleted" - }, - "204": { - "content": { - "*/*": { - "schema": { - "type": "string" - } - } - }, - "description": "No content. Deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete all elements in cache", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/keys/count": { - "get": { - "operationId": "admin/cache_getCount", - "parameters": [ - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "integer", - "format": "int64" - } - } - }, - "description": "Successfully" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Count the DB size of Redis", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/keys/count/{keyOfEntity}": { - "get": { - "operationId": "admin/cache_getCount_1", - "parameters": [ - { - "in": "path", - "name": "keyOfEntity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "integer", - "format": "int64" - } - } - }, - "description": "Successfully" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Count number of elements in cache by key of entity", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/keys/info": { - "get": { - "operationId": "admin/cache_getKeyInfo", - "parameters": [ - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SetString" - } - } - }, - "description": "Successfully" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get key info for entities in cache", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/keys/info/{nameOfEntity}": { - "get": { - "operationId": "admin/cache_getKeyInfo_1", - "parameters": [ - { - "in": "path", - "name": "nameOfEntity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/SetString" - } - } - }, - "description": "Successfully" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get key info for a given entity in cache", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/admin/cache/status": { - "get": { - "operationId": "admin/cache_getCacheStatuses", - "parameters": [ - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/MapStringObject" - } - } - }, - "description": "Successfully retrieved cache statuses" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get cache statuses for all entities", - "tags": [ - "admin/cache" - ], - "x-entur-permissions": { - "value": "product-admin-api-access:endre" - } - } - }, - "/amount-of-price-unit-products": { - "get": { - "operationId": "amount-of-price-unit-products_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id for the language", - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AmountOfPriceUnitProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves an amount of price unit products, filtered by given parameter(s)", - "tags": [ - "amount-of-price-unit-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "amount-of-price-unit-products_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AmountOfPriceUnitProduct" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create an AmountOfPriceUnitProduct", - "tags": [ - "amount-of-price-unit-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/amount-of-price-unit-products/{id}": { - "get": { - "operationId": "amount-of-price-unit-products_getById", - "parameters": [ - { - "description": "The unique id to identify the amount of price unit product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the amount of price unit product", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AmountOfPriceUnitProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of an AmountOfPriceUnitProduct by id", - "tags": [ - "amount-of-price-unit-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/amount-of-price-unit-products/{id}/{version}": { - "get": { - "operationId": "amount-of-price-unit-products_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify the an amount of price unit product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the amount of price unit product", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AmountOfPriceUnitProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves an AmountOfPriceUnitProduct by id and version", - "tags": [ - "amount-of-price-unit-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "amount-of-price-unit-products_update", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the amount of price unit product", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AmountOfPriceUnitProduct" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update an AmountOfPriceUnitProduct parameter.", - "tags": [ - "amount-of-price-unit-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/availability-conditions": { - "get": { - "operationId": "availability-conditions_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AvailabilityCondition" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all availability condition parameters", - "tags": [ - "availability-conditions" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "availability-conditions_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvailabilityCondition" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a Availability Condition", - "tags": [ - "availability-conditions" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/availability-conditions/{id}/{version}": { - "delete": { - "operationId": "availability-conditions_deleteById", - "parameters": [ - { - "description": "The id to identify a Availability Condition", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Availability Condition", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an AvailabilityCondition by id and version", - "tags": [ - "availability-conditions" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "availability-conditions_getById", - "parameters": [ - { - "description": "The id to identify a Availability Condition ", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Availability Condition", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/AvailabilityCondition" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves Availability Condition for id and version", - "tags": [ - "availability-conditions" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "availability-conditions_update", - "parameters": [ - { - "description": "The id to identify a Availability Condition", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Availability Condition", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvailabilityCondition" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing Availability Condition", - "tags": [ - "availability-conditions" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/capped-discount-rights": { - "get": { - "operationId": "capped-discount-rights_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "The unique id for the language", - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CappedDiscountRight" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a capped discount right, filtered by given parameter(s)", - "tags": [ - "capped-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "capped-discount-rights_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CappedDiscountRightInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a capped discount right", - "tags": [ - "capped-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/capped-discount-rights/{id}": { - "get": { - "operationId": "capped-discount-rights_getById", - "parameters": [ - { - "description": "The unique id to identify the capped discount right", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the capped discount right", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Toggles whether you want to find latest version or latest active version for specific environment, so in staging that would be a proposed version, while in production it will only be a versioned version", - "in": "query", - "name": "findActiveInEnvironment", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CappedDiscountRight" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of a capped discount right by id", - "tags": [ - "capped-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/capped-discount-rights/{id}/{version}": { - "get": { - "operationId": "capped-discount-rights_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify the capped discount right", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the capped discount right", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CappedDiscountRight" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a capped discount right by id and version", - "tags": [ - "capped-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "capped-discount-rights_update", - "parameters": [ - { - "description": "The unique id to identify the capped discount right", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the capped discount right", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CappedDiscountRightInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a capped discount right", - "tags": [ - "capped-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/charging-moments": { - "post": { - "operationId": "charging-moments_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChargingMomentInsert" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a charging moment controller", - "tags": [ - "charging-moments" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/charging-moments/{id}/{version}": { - "get": { - "operationId": "charging-moments_getByIdAndVersion", - "parameters": [ - { - "description": "The id to identify a ChargingMooment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ChargingMoment", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChargingMoment" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves charging moment for id and version", - "tags": [ - "charging-moments" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/charging-policies": { - "get": { - "operationId": "charging-policies_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ChargingPolicy" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all charging policies", - "tags": [ - "charging-policies" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/companion-profiles": { - "get": { - "deprecated": true, - "operationId": "companion-profiles_findByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CompanionProfile" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all companion profile", - "tags": [ - "companion-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/companion-profiles/{id}/{version}": { - "get": { - "deprecated": true, - "operationId": "companion-profiles_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a companion profile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the companion profile", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CompanionProfile" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a companion profile by id and version", - "tags": [ - "companion-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/day-types": { - "get": { - "operationId": "day-types_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DayType" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all day types", - "tags": [ - "day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "day-types_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DayType" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a dayType", - "tags": [ - "day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/day-types/{id}/{version}": { - "delete": { - "operationId": "day-types_deleteById", - "parameters": [ - { - "description": "The id to identify a day type", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the day type", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an day type given by id and version", - "tags": [ - "day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "day-types_getById", - "parameters": [ - { - "description": "The id to identify a DayType", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the DayType", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/DayType" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves day type for id and version", - "tags": [ - "day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "day-types_update", - "parameters": [ - { - "description": "The id to identify a DayType", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the DayType", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DayType" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing DayType", - "tags": [ - "day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/distance-matrix-elements": { - "get": { - "operationId": "distance-matrix-elements_findByGroupIdOrVersionOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The netexId to identify group the distance matrix elements belong to", - "in": "query", - "name": "groupId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version of the group the distance matrix elements belong to", - "in": "query", - "name": "groupVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The page of the pagination", - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The size of the page", - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DistanceMatrixElement" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves distance matrix elements and filter by query params", - "tags": [ - "distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "distance-matrix-elements_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistanceMatrixElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a DistanceElement", - "tags": [ - "distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/distance-matrix-elements/batch/{version}": { - "put": { - "operationId": "distance-matrix-elements_updateMany", - "parameters": [ - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistanceMatrixElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update batch of distance matrix elements", - "tags": [ - "distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/distance-matrix-elements/{id}/{version}": { - "get": { - "operationId": "distance-matrix-elements_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a charging moment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistanceMatrixElement" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a distance-matrix-elements by id and version", - "tags": [ - "distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/distribution-channel-usages/{id}": { - "get": { - "operationId": "distribution-channel-usages_getById", - "parameters": [ - { - "description": "The netex-id for a given distributionChannel the service should fong refences for.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves references where the distribution-channel with given id is referenced", - "tags": [ - "distribution-channel-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/entitlement-given": { - "get": { - "operationId": "entitlement-given_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntitlementGiven" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all entitlement given", - "tags": [ - "entitlement-given" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "entitlement-given_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementGiven" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a EntitlementGiven", - "tags": [ - "entitlement-given" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/entitlement-given/{id}/{version}": { - "delete": { - "operationId": "entitlement-given_deleteById", - "parameters": [ - { - "description": "The id to identify an entitlement given", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the entitlement given", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an entitlement given by id and version", - "tags": [ - "entitlement-given" - ] - }, - "get": { - "operationId": "entitlement-given_getById", - "parameters": [ - { - "description": "The id to identify a EntitlementGiven", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the EntitlementGiven", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/EntitlementGiven" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves entitlement given for id and version", - "tags": [ - "entitlement-given" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "entitlement-given_update", - "parameters": [ - { - "description": "The id to identify a EntitlementGiven", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the EntitlementGiven", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementGiven" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing EntitlementGiven", - "tags": [ - "entitlement-given" - ] - } - }, - "/entitlement-products": { - "get": { - "operationId": "entitlement-products_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntitlementProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves entitlement-products by organisation id and fare frame id", - "tags": [ - "entitlement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/entitlements-required": { - "get": { - "operationId": "entitlements-required_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EntitlementRequired" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all entitlements required", - "tags": [ - "entitlements-required" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "entitlements-required_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementRequired" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create an EntitlementRequired", - "tags": [ - "entitlements-required" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/entitlements-required/{id}/{version}": { - "delete": { - "operationId": "entitlements-required_deleteById", - "parameters": [ - { - "description": "The id to identify an EntitlementRequired", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the EntitlementRequired", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an EntitlementRequired by id and version", - "tags": [ - "entitlements-required" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "entitlements-required_getById", - "parameters": [ - { - "description": "The id to identify a EntitlementRequired", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the EntitlementRequired", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/EntitlementRequired" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves EntitlementRequired for id and version", - "tags": [ - "entitlements-required" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "entitlements-required_update", - "parameters": [ - { - "description": "The id to identify a EntitlementRequired", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the EntitlementRequired", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementRequired" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing EntitlementRequired", - "tags": [ - "entitlements-required" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/exchanging": { - "get": { - "operationId": "exchanging_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Languagecode", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "summary": "Retrieves all exchanging rules", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "exchanging_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExchangingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create an exchanging rule", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/exchanging-possibilities": { - "post": { - "operationId": "exchanging-possibilities_getExchangingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParameterPossibilitiesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExchangingAlternatives" - } - } - } - }, - "description": "Returns the resource." - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves exchanging rules for given elements", - "tags": [ - "exchanging-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging-possibilities/fare-structure-element/{id}/{version}": { - "get": { - "operationId": "exchanging-possibilities_getFSEExchangingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id to identify a fare structure element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves exchanging rules for given elements", - "tags": [ - "exchanging-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging-possibilities/preassigned-product/{id}/{version}": { - "get": { - "operationId": "exchanging-possibilities_getFPExchangingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves exchanging rules for given elements", - "tags": [ - "exchanging-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging-possibilities/sales-package/{id}/{version}": { - "get": { - "operationId": "exchanging-possibilities_getSPExchangingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a sales package.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves exchanging rules for given elements", - "tags": [ - "exchanging-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging-possibilities/validable-element/{id}/{version}": { - "get": { - "operationId": "exchanging-possibilities_getVEExchangingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id to identify a validable element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves exchanging rules for given elements", - "tags": [ - "exchanging-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging/{id}": { - "get": { - "operationId": "exchanging_getById", - "parameters": [ - { - "description": "The unique id to identify an exchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the purchase window", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Exchanging" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "summary": "Retrieves an exchanging rule by id", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/exchanging/{id}/{version}": { - "get": { - "operationId": "exchanging_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify an exchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the exchanging", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Exchanging" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "summary": "Retrieves an exchanging rule by id and version", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "exchanging_update", - "parameters": [ - { - "description": "The unique id to identify an exchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the exchanging", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExchangingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "summary": "Update exchanging rule", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-day-types": { - "get": { - "operationId": "fare-day-types_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareDayType" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all fare day types", - "tags": [ - "fare-day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fare-day-types_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareDayType" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a fare day Type", - "tags": [ - "fare-day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-day-types/{id}/{version}": { - "delete": { - "operationId": "fare-day-types_deleteById", - "parameters": [ - { - "description": "The id to identify a fare day type", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fare day type", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an day type given by id and version", - "tags": [ - "fare-day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "fare-day-types_getById", - "parameters": [ - { - "description": "The id to identify a fare day type", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fare day type", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareDayType" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fare day type for id and version", - "tags": [ - "fare-day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fare-day-types_update", - "parameters": [ - { - "description": "The id to identify a fare day type", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fare day type", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareDayType" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing fare day type", - "tags": [ - "fare-day-types" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-frames": { - "get": { - "operationId": "fare-frames_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareFrame" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fare frames by organisation id", - "tags": [ - "fare-frames" - ] - } - }, - "/fare-frames/{id}": { - "get": { - "operationId": "fare-frames_getById", - "parameters": [ - { - "description": "The unique id to identify a fareFrames", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fareFrames", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareFrame" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a fareFrames by id", - "tags": [ - "fare-frames" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-frames/{id}/{version}": { - "get": { - "operationId": "fare-frames_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a fareFrames", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fareFrames", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareFrame" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a fareFrames by id and version.", - "tags": [ - "fare-frames" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-products": { - "get": { - "operationId": "fare-products_findByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify the type of fare product", - "in": "query", - "name": "typeOfFareProductId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all fare-products, filtered by given parameter(s)", - "tags": [ - "fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-quota-factors": { - "get": { - "operationId": "fare-quota-factors_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareQuotaFactor" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all fare quota factors given", - "tags": [ - "fare-quota-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fare-quota-factors_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareQuotaFactor" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a fareQuotaFactor", - "tags": [ - "fare-quota-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-quota-factors/{id}/{version}": { - "delete": { - "operationId": "fare-quota-factors_deleteById", - "parameters": [ - { - "description": "The id to identify a FareQuotaFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareQuotaFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a FareQuotaFactor by id and version", - "tags": [ - "fare-quota-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "fare-quota-factors_getById", - "parameters": [ - { - "description": "The id to identify a FareQuotaFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareQuotaFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareQuotaFactor" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fare quota factor for id and version", - "tags": [ - "fare-quota-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fare-quota-factors_update", - "parameters": [ - { - "description": "The id to identify a FareQuotaFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareQuotaFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareQuotaFactor" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing FareQuotaFactor", - "tags": [ - "fare-quota-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-sections": { - "get": { - "operationId": "fare-sections_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareSection" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all fare sections", - "tags": [ - "fare-sections" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fare-sections_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareSection" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a fareSection", - "tags": [ - "fare-sections" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-sections/{id}/{version}": { - "delete": { - "operationId": "fare-sections_deleteById", - "parameters": [ - { - "description": "The id to identify a FareSection", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareSection", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a FareSection by id and version", - "tags": [ - "fare-sections" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "fare-sections_getById", - "parameters": [ - { - "description": "The id to identify a FareSection", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareSection", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalStructureFactor" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fare section for id and version", - "tags": [ - "fare-sections" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fare-sections_update", - "parameters": [ - { - "description": "The id to identify a FareSection", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FareSection", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareSection" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing FareSection", - "tags": [ - "fare-sections" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-structure-element-usages/{id}": { - "get": { - "operationId": "fare-structure-element-usages_getMinimalVersionInfoById", - "parameters": [ - { - "description": "The netex_id to identify a FareStructureElement", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MininmalVersionInfo" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves products/validable elements where the given FareStructureElement-id is referenced", - "tags": [ - "fare-structure-element-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-structure-elements": { - "get": { - "operationId": "fare-structure-elements_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset for an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "$ref": "#/components/schemas/SeqStatusFilterEnum" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareStructureElement" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a preassignedFareProduct by organisation id", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fare-structure-elements_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareStructureElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a Fare structure element", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-structure-elements/count": { - "get": { - "operationId": "fare-structure-elements_getCount", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "$ref": "#/components/schemas/SeqStatusFilterEnum" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/Count" - } - } - }, - "description": "Entity updated successfully" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-structure-elements/pages": { - "get": { - "operationId": "fare-structure-elements_findPageByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Number of elements listed in requested page", - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The given page one want in return", - "in": "query", - "name": "pageNumber", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "$ref": "#/components/schemas/SeqStatusFilterEnum" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareStructureElementPageWrapper" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-structure-elements/{id}": { - "get": { - "operationId": "fare-structure-elements_getById", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/FareStructureElement" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a fare structure element by netexId", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-structure-elements/{id}/{version}": { - "get": { - "operationId": "fare-structure-elements_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/FareStructureElement" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a fare structure element by id and version", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fare-structure-elements_update", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareStructureElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a fare structure element", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-structure-elements/{id}/{version}/distance-matrix-elements": { - "get": { - "deprecated": true, - "description": "No longer in use. DMEs are connected by geographicalStructureFactors", - "operationId": "fare-structure-elements_getPointToPointFares", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The limited numbers of distance matrix elements returned in the set", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The offset of distance matrix elements returned in the set", - "in": "query", - "name": "offset", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DistanceMatrixElement" - } - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the distance matrix elements of the fare structure element", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-structure-elements/{id}/{version}/geographical-intervals": { - "get": { - "operationId": "fare-structure-elements_getGeographicalIntervals", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The limited numbers of geographical intervals returned in the set", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The offset of geographical intervals returned in the set", - "in": "query", - "name": "offset", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeographicalInterval" - } - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the geographical intervals of the fare structure element", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-table-usages/{id}": { - "get": { - "operationId": "fare-table-usages_getById", - "parameters": [ - { - "description": "The netex_id to identify a fare table ", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves references where the given fare table id is referenced", - "tags": [ - "fare-table-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-tables": { - "get": { - "operationId": "fare-tables_findByOrganisationIdOrFareFrameId", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "if set to true fare table cells will be omitted", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareTable" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all faretables. Limiting selection by fareFrameId parameter is supported", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fare-tables_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareTableInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a fare table", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-tables/count": { - "get": { - "operationId": "fare-tables_getFareTableCount", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Count" - } - } - }, - "description": "Returs the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of fareTables. Limiting selection by fareFrameId and orgId parameter is supported", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-tables/pages": { - "get": { - "operationId": "fare-tables_findPageByOrganisationIdOrFareFrameId", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Size of page", - "in": "query", - "name": "pageSize", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Page number", - "in": "query", - "name": "pageNumber", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "if set to true fare table cells will be omitted", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareTablePageWrapper" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fareTables for a given page. Limiting selection by fareFrameId and orgId parameter is supported", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-tables/products/{id}": { - "get": { - "operationId": "fare-tables_getByFareProductId", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareTable" - } - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a faretable by product id", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-tables/{ftId}/cells/{cellId}/fare-prices": { - "patch": { - "operationId": "fare-tables_updateFarePriceForFareTable", - "parameters": [ - { - "description": "The id to identify a fare table", - "in": "path", - "name": "ftId", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id to identify a cell", - "in": "path", - "name": "cellId", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "version", - "required": true, - "schema": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The versjon of the fare table", - "in": "query", - "name": "fareTableVersionId", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FarePriceUpdate" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates a FarePrice for FareTable", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fare-tables/{id}": { - "get": { - "description": "Note! Only fare tables with active versions will be fetched", - "operationId": "fare-tables_getById", - "parameters": [ - { - "description": "The unique id to identify a fare table", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The id for the version of the fare table", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "if set to true fare table cells will be omitted", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareTable" - } - } - }, - "description": "Returns the fare table" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a fare table by id", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/fare-tables/{id}/{version}": { - "get": { - "operationId": "fare-tables_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a fare table", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The id for the version of the fare table", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "if set to true fare table cells will be omitted", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareTable" - } - } - }, - "description": "Returns the fare table" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a fare table by id and version", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fare-tables_update", - "parameters": [ - { - "description": "The unique id to identify a fare table", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the fare table", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FareTableInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a faretable", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/frequencies-of-use": { - "get": { - "operationId": "frequencies-of-use_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FrequencyOfUse" - } - } - } - }, - "description": "Returns the frequencies of use" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all frequencies of use", - "tags": [ - "frequencies-of-use" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "frequencies-of-use_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyOfUseInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a frequency-of-use", - "tags": [ - "frequencies-of-use" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/frequencies-of-use/{id}/{version}": { - "get": { - "operationId": "frequencies-of-use_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a frequency of use", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the frequency of use", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyOfUse" - } - } - }, - "description": "Returns the frequencies of use" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves frequencies of use by id and version", - "tags": [ - "frequencies-of-use" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "frequencies-of-use_update", - "parameters": [ - { - "description": "The unique id to identify a frequency of use", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the frequency of use", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FrequencyOfUseInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a frequency of use parameter.", - "tags": [ - "frequencies-of-use" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fulfilment-methods": { - "get": { - "operationId": "fulfilment-methods_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FulfilmentMethod" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all fulfilment methods", - "tags": [ - "fulfilment-methods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "fulfilment-methods_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FulfilmentMethod" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a FulfilmentMethod", - "tags": [ - "fulfilment-methods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/fulfilment-methods/{id}/{version}": { - "delete": { - "operationId": "fulfilment-methods_deleteById", - "parameters": [ - { - "description": "The id to identify a FulfilmentMethod", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FulfilmentMethod", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a FulfilmentMethod by id and version", - "tags": [ - "fulfilment-methods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "fulfilment-methods_getById", - "parameters": [ - { - "description": "The id to identify a FulfilmentMethod", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FulfilmentMethod", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FulfilmentMethod" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves fulfilment method for id and version", - "tags": [ - "fulfilment-methods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "fulfilment-methods_update", - "parameters": [ - { - "description": "The id to identify a FulfilmentMethod", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the FulfilmentMethod", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FulfilmentMethod" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing FulfilmentMethod", - "tags": [ - "fulfilment-methods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/general-groups-of-entities": { - "get": { - "operationId": "general-groups-of-entities_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeneralGroupOfEntities" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all general groups of entities parameters", - "tags": [ - "general-groups-of-entities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "general-groups-of-entities_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeneralGroupOfEntities" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a general group of entities", - "tags": [ - "general-groups-of-entities" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/general-groups-of-entities/{id}/{version}": { - "delete": { - "operationId": "general-groups-of-entities_deleteById", - "parameters": [ - { - "description": "The id to identify a general group of entities", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the general group of entities", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete a general group of entities given id and version", - "tags": [ - "general-groups-of-entities" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "general-groups-of-entities_getById", - "parameters": [ - { - "description": "The id to identify a GeneralGroupOfEntities", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the GeneralGroupOfEntities", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/GeneralGroupOfEntities" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves general group of entities given id and version", - "tags": [ - "general-groups-of-entities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "general-groups-of-entities_update", - "parameters": [ - { - "description": "The id to identify a general group of entities", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the general group of entities", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeneralGroupOfEntities" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing general group of entities", - "tags": [ - "general-groups-of-entities" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/generic-parameter-assignments": { - "get": { - "operationId": "generic-parameter-assignments_getAll", - "parameters": [ - { - "description": "The unique id to identify the data owner.", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify the data set to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Specify with \u0027a\u0027 or \u0027e\u0027 what set of gpa implementation should be retrieved", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "$ref": "#/components/schemas/SeqStatusFilterEnum" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves generic parameter assignment by fare frame id or organisation", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "generic-parameter-assignments_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericParameterAssignmentInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a generic parameter assignment", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/generic-parameter-assignments/batch": { - "post": { - "operationId": "generic-parameter-assignments_createMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericParameterAssignmentInsert" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entities created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create many generic parameter assignments", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/generic-parameter-assignments/{id}": { - "get": { - "operationId": "generic-parameter-assignments_getById", - "parameters": [ - { - "description": "The unique id to identify a generic parameter assignment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the generic parameter assignment", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a generic parameter assignment by id", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/generic-parameter-assignments/{id}/{version}": { - "get": { - "operationId": "generic-parameter-assignments_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a generic parameter assignment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the generic parameter assignment", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a generic parameter assignment by id and version", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "generic-parameter-assignments_update", - "parameters": [ - { - "description": "The unique id to identify a generic parameter assignment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the generic parameter assignment", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericParameterAssignmentInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a generic parameter assignment", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/geographical-intervals": { - "post": { - "operationId": "geographical-intervals_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalIntervalInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a GeographicalInterval", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/geographical-intervals/batch": { - "post": { - "operationId": "geographical-intervals_createMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a list of GeographicalIntervals", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "put": { - "operationId": "geographical-intervals_updateMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update multiple geographical intervals", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/geographical-intervals/{giId}/fare-prices/{fpId}": { - "patch": { - "operationId": "geographical-intervals_updateFarePrice", - "parameters": [ - { - "description": "The id to identify a geographical interval", - "in": "path", - "name": "giId", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id to identify a fare price", - "in": "path", - "name": "fpId", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version id to identify a geographical interval", - "in": "query", - "name": "giVersionId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FarePriceUpdate" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update price for a geographical interval by netexId", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/geographical-intervals/{id}": { - "get": { - "operationId": "geographical-intervals_getById", - "parameters": [ - { - "description": "The unique id to identify a geographical interval", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the geographical interval", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalInterval" - } - } - }, - "description": "Returns the geographical interval" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a geographical interval by id", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/geographical-intervals/{id}/{version}": { - "get": { - "operationId": "geographical-intervals_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a geographical interval", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the geographical interval", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalInterval" - } - } - }, - "description": "Returns the geographical interval" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a geographical interval by id and version", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/geographical-structure-factors": { - "get": { - "operationId": "geographical-structure-factors_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeographicalStructureFactor" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all geographical structure factors", - "tags": [ - "geographical-structure-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "geographical-structure-factors_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalStructureFactor" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a GeographicalStructureFactor", - "tags": [ - "geographical-structure-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/geographical-structure-factors-usages/{id}": { - "get": { - "operationId": "geographical-structure-factors-usages_getById", - "parameters": [ - { - "description": "The netex_id to identify a GeographicalStructureFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves references where the given GeographicalStructureFactor id is referenced", - "tags": [ - "geographical-structure-factors-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/geographical-structure-factors/{id}/{version}": { - "delete": { - "operationId": "geographical-structure-factors_deleteById", - "parameters": [ - { - "description": "The id to identify a GeographicalStructureFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the GeographicalStructureFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a GeographicalStructureFactor by id and version", - "tags": [ - "geographical-structure-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "geographical-structure-factors_getById", - "parameters": [ - { - "description": "The id to identify a GeographicalStructureFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the GeographicalStructureFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalStructureFactor" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves geographical structure factor for id and version", - "tags": [ - "geographical-structure-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "geographical-structure-factors_update", - "parameters": [ - { - "description": "The id to identify a GeographicalStructureFactor", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the GeographicalStructureFactor", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GeographicalStructureFactor" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing GeographicalStructureFactor", - "tags": [ - "geographical-structure-factors" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/group-of-distance-matrix-elements": { - "get": { - "operationId": "group-of-distance-matrix-elements_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all groups of distance matrix elements", - "tags": [ - "group-of-distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "group-of-distance-matrix-elements_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupOfDistanceMatrixElementsInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a GroupOfDistanceElement", - "tags": [ - "group-of-distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/group-of-distance-matrix-elements/{id}/{version}": { - "get": { - "operationId": "group-of-distance-matrix-elements_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a GroupOfDistanceMatrixElements", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the GroupOfDistanceMatrixElements", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a GroupOfDistanceMatrixElementsEntity by id and version", - "tags": [ - "group-of-distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/group-tickets": { - "get": { - "operationId": "group-tickets_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupTicket" - } - } - } - }, - "description": "Returns all group tickets" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all group tickets accessible by user rights", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "group-tickets_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupTicketInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a group ticket", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/group-tickets/{id}": { - "get": { - "operationId": "group-tickets_getById", - "parameters": [ - { - "description": "The unique id to identify a group ticket", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the group ticket", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupTicket" - } - } - }, - "description": "Returns the group ticket" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a group ticket by id", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/group-tickets/{id}/{version}": { - "get": { - "operationId": "group-tickets_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a group ticket", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the group ticket", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupTicket" - } - } - }, - "description": "Returns the group ticket" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a group ticket by id and version", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "group-tickets_update", - "parameters": [ - { - "description": "The unique id to identify a group ticket", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the group ticket", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GroupTicket" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a group ticket", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/interchangings": { - "get": { - "operationId": "interchangings_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset for an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Interchanging" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all interchangings for a given fare frame", - "tags": [ - "interchangings" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "interchangings_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InterchangingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "Returns the info" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create an interchanging", - "tags": [ - "interchangings" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/interchangings/{id}/{version}": { - "get": { - "operationId": "interchangings_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a interchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the interchanging", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Interchanging" - } - } - }, - "description": "Returns the interchanging" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves an interchanging by id and version", - "tags": [ - "interchangings" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "interchangings_update", - "parameters": [ - { - "description": "The unique id to identify a interchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the interchanging", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InterchangingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update an interchanging", - "tags": [ - "interchangings" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/journey-patterns": { - "get": { - "operationId": "journey-patterns_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JourneyPattern" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all journey patterns", - "tags": [ - "journey-patterns" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "journey-patterns_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JourneyPattern" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a JourneyPattern", - "tags": [ - "journey-patterns" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/journey-patterns/{id}/{version}": { - "delete": { - "operationId": "journey-patterns_deleteById", - "parameters": [ - { - "description": "The id to identify a JourneyPattern", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the JourneyPattern", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a JourneyPattern by id and version", - "tags": [ - "journey-patterns" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "journey-patterns_getById", - "parameters": [ - { - "description": "The id to identify a JourneyPattern", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the JourneyPattern", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JourneyPattern" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves journey pattern for id and version", - "tags": [ - "journey-patterns" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "journey-patterns_update", - "parameters": [ - { - "description": "The id to identify a JourneyPattern", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the JourneyPattern", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JourneyPattern" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing JourneyPattern", - "tags": [ - "journey-patterns" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/luggage-allowances": { - "get": { - "operationId": "luggage-allowances_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LuggageAllowance" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all luggage allowances", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "luggage-allowances_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LuggageAllowance" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a luggage allowance", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/luggage-allowances/{id}/versions": { - "get": { - "operationId": "luggage-allowances_getVersionsOrActiveById", - "parameters": [ - { - "description": "The id to identify a LuggageAllowance", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", - "in": "query", - "name": "active", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LuggageAllowance" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves luggage allowance versions for a given id", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/luggage-allowances/{id}/{version}": { - "delete": { - "operationId": "luggage-allowances_deleteById", - "parameters": [ - { - "description": "The id to identify a LuggageAllowance", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The id for the version of the LuggageAllowance", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Entity deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete an existing LuggageAllowance", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "luggage-allowances_getById", - "parameters": [ - { - "description": "The id to identify a LuggageAllowance", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the LuggageAllowance", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LuggageAllowance" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves luggage allowance for id and version", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "luggage-allowances_update", - "parameters": [ - { - "description": "The id to identify a LuggageAllowance", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the LuggageAllowance", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LuggageAllowance" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing LuggageAllowance", - "tags": [ - "luggage-allowances" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/meta-data": { - "post": { - "operationId": "meta-data_create", - "parameters": [ - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Metadata" - } - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create metadata", - "tags": [ - "meta-data" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/meta-data/{id}/{version}": { - "get": { - "operationId": "meta-data_getById", - "parameters": [ - { - "description": "The netex id to identify a metadata entry", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version id for the version of the metadata entry", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Metadata" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get metadata for a netexid and version", - "tags": [ - "meta-data" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/parameter-usages/{id}": { - "get": { - "operationId": "parameter-usages_getById", - "parameters": [ - { - "description": "The id to identify a parameter usage mapping ", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves parameter usages for id", - "tags": [ - "parameter-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/penalty-policies": { - "get": { - "operationId": "penalty Policy_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all penaltyPolicy parameters", - "tags": [ - "penalty Policy" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "penalty Policy_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "tags": [ - "penalty Policy" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/penalty-policies/{id}/{version}": { - "delete": { - "operationId": "penalty Policy_deleteById", - "parameters": [ - { - "description": "The id to identify an penalty policy", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the penalty policy", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes an penalty policy by id and version", - "tags": [ - "penalty Policy" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "penalty Policy_getById", - "parameters": [ - { - "description": "The id to identify a PenaltyPolicy", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the PenaltyPolicy", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy for id and version", - "tags": [ - "penalty Policy" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "penalty Policy_update", - "parameters": [ - { - "description": "The id to identify a PenaltyPolicy", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the PenaltyPolicy", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing PenaltyPolicy", - "tags": [ - "penalty Policy" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/penalty-policy-possibilities": { - "post": { - "operationId": "penalty-policy-possibilities_getPenaltyPolicyPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParameterPossibilitiesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicyAlternatives" - } - } - } - }, - "description": "Returns the resource." - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy rules for given elements", - "tags": [ - "penalty-policy-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/penalty-policy-possibilities/fare-structure-element/{id}/{version}": { - "get": { - "operationId": "penalty-policy-possibilities_getFSEPenaltyPolicyPossibilities", - "parameters": [ - { - "description": "The id to identify a fare structure element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy rules for given elements", - "tags": [ - "penalty-policy-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/penalty-policy-possibilities/preassigned-product/{id}/{version}": { - "get": { - "operationId": "penalty-policy-possibilities_getFPPenaltyPolicyPossibilities", - "parameters": [ - { - "description": "The id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy rules for given elements", - "tags": [ - "penalty-policy-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/penalty-policy-possibilities/sales-package/{id}/{version}": { - "get": { - "operationId": "penalty-policy-possibilities_getSPPenaltyPolicyPossibilities", - "parameters": [ - { - "description": "The unique id to identify a sales package.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy rules for given elements", - "tags": [ - "penalty-policy-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/penalty-policy-possibilities/validable-element/{id}/{version}": { - "get": { - "operationId": "penalty-policy-possibilities_getVEPenaltyPolicyPossibilities", - "parameters": [ - { - "description": "The id to identify a validable element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves penalty policy rules for given elements", - "tags": [ - "penalty-policy-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/period-tickets": { - "get": { - "operationId": "period-tickets_findPeriodTicketsByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PeriodTicketInfo" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a period tickets and its userprofiles and usage validity periods by authority", - "tags": [ - "period-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/preassigned-products": { - "get": { - "operationId": "preassigned-products_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "the unique id for the language", - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PreassignedFareProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a preassignedFareProduct by organisation id", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "preassigned-products_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreassignedFareProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a PreassignedFareProduct", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/preassigned-products/count": { - "get": { - "operationId": "preassigned-products_getPreassignedFareProductCount", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Count" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/preassigned-products/pages": { - "get": { - "operationId": "preassigned-products_findPageByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Number of elements listed in requested page", - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The given page one want in return", - "in": "query", - "name": "pageNumber", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "the unique id for the language", - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreassignedFareProductPageWrapper" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/preassigned-products/{id}": { - "get": { - "operationId": "preassigned-products_getById", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreassignedFareProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieve the latest version of preassignedFareProduct by id", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/preassigned-products/{id}/refunding": { - "get": { - "operationId": "preassigned-products_getRefundingByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a fareProduct", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "query", - "name": "version", - "required": true, - "schema": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "the unique id for the language", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version of the fareProduct", - "in": "query", - "name": "productVersionId", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refunding" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives refunding rules by fare product id and version", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/preassigned-products/{id}/{version}": { - "get": { - "operationId": "preassigned-products_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreassignedFareProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of preassignedFareProduct by id and version", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "preassigned-products_update", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreassignedFareProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a preassigned fare product parameter.", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/pricing-parameter-set": { - "get": { - "operationId": "pricing-parameter-set_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PricingParameterSet" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported", - "tags": [ - "pricing-parameter-set" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/product-tree-explanations": { - "get": { - "operationId": "product-tree-explanations_get", - "parameters": [ - { - "description": "The nameOfClass to identify a ProductTreeExplained, i.e \u0027SalesPackage\u0027", - "in": "query", - "name": "nameOfClass", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from BCP-47, e.g. \u0027nb\u0027 or \u0027en\u0027", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductTreeExplained" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all explanations", - "tags": [ - "product-tree-explanations" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/product-tree-explanations/{id}/{version}": { - "get": { - "operationId": "product-tree-explanations_get_1", - "parameters": [ - { - "description": "The netexId to identify a ProductTreeExplained", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The version to identify a ProductTreeExplained", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from BCP-47, e.g. \u0027nb\u0027 or \u0027en\u0027", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductTreeExplained" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves explanation for netexId and version", - "tags": [ - "product-tree-explanations" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/product-usages/{id}": { - "get": { - "operationId": "product-usages_getById", - "parameters": [ - { - "description": "The id to identify a parameter usage mapping ", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves references whe the product with given id is referenced", - "tags": [ - "product-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/purchase-windows": { - "get": { - "operationId": "purchase-windows_getAll", - "parameters": [ - { - "description": "The unique organisation id to identify the owner of the data", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique fareFrame id to identify the owner of the data", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PurchaseWindow" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves purchase window by fareFrame id or organisation id", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "purchase-windows_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PurchaseWindowInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a purchase window", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/purchase-windows/{id}": { - "get": { - "operationId": "purchase-windows_getById", - "parameters": [ - { - "description": "The unique id to identify a purchase window", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the purchase window", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PurchaseWindow" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a purchase window by id", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/purchase-windows/{id}/{version}": { - "get": { - "operationId": "purchase-windows_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a purchase window", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the purchase window", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PurchaseWindow" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a purchase window by id and version", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "purchase-windows_update", - "parameters": [ - { - "description": "The unique id to identify a purchase window", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the purchase window", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PurchaseWindowInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a purchase window", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/refunding": { - "get": { - "operationId": "refunding_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Refunding" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all refundings", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "refunding_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefundingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a refunding rules", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/refunding-possibilities": { - "post": { - "operationId": "refunding-possibilities_getRefundingPossibilities", - "parameters": [ - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParameterPossibilitiesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RefundingAlternatives" - } - } - } - }, - "description": "Returns the resource." - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves refunding rules for given elements", - "tags": [ - "refunding-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/refunding-possibilities/preassigned-product/{id}/{version}": { - "get": { - "operationId": "refunding-possibilities_getFPRefundingPossibilities", - "parameters": [ - { - "description": "The unique id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves refunding rules for given elements", - "tags": [ - "refunding-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/refunding-possibilities/sales-package/{id}/{version}": { - "get": { - "operationId": "refunding-possibilities_getSPRefundingPossibilities", - "parameters": [ - { - "description": "The unique id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Refunding" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves refunding rules for given elements", - "tags": [ - "refunding-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/refunding-possibilities/validable-element/{id}/{version}": { - "get": { - "operationId": "refunding-possibilities_getVERefundingPossibilities", - "parameters": [ - { - "description": "The unique id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Refunding" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves refunding rules for given elements", - "tags": [ - "refunding-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/refunding/{id}": { - "get": { - "operationId": "refunding_getById", - "parameters": [ - { - "description": "The unique id to identify a refunding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the refunding", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refunding" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a refunding rule by id", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/refunding/{id}/{version}": { - "get": { - "operationId": "refunding_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a refunding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the refunding", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refunding" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a refunding rule by id and version", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "refunding_update", - "parameters": [ - { - "description": "The unique id to identify a refunding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the refunding", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefundingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a refunding rule", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/replacing": { - "get": { - "operationId": "replacing_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Replacing" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all replacings", - "tags": [ - "replacing" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "replacing_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Replacing" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a Replacing", - "tags": [ - "replacing" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/replacing/{id}/{version}": { - "delete": { - "operationId": "replacing_deleteById", - "parameters": [ - { - "description": "The id to identify a Replacing", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Replacing", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Entity deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete an existing replacing", - "tags": [ - "replacing" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "replacing_getByIds", - "parameters": [ - { - "description": "The id to identify a Replacing", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The id for the version of the Replacing", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Replacing" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves replacing for id and version", - "tags": [ - "replacing" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "replacing_update", - "parameters": [ - { - "description": "The id to identify a Replacing", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Replacing", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Replacing" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing Replacing", - "tags": [ - "replacing" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/reserving": { - "get": { - "operationId": "reserving_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reserving" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all reserving rules", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "reserving_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReservingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a reserving rule", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/reserving/{id}": { - "get": { - "operationId": "reserving_getById", - "parameters": [ - { - "description": "The unique ID to identify a reserving.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The ID for the version of the reservation.", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3.", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reserving" - } - } - }, - "description": "Returns the reserving." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a reserving rule by ID.", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/reserving/{id}/{version}": { - "get": { - "operationId": "reserving_getByIdAndVersion", - "parameters": [ - { - "description": "The unique ID to identify a reserving.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The ID for the version of the reservation.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reserving" - } - } - }, - "description": "Returns the reserving." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a reserving rule by id and version.", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "reserving_update", - "parameters": [ - { - "description": "The unique ID to identify a reserving.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The ID for the version of the reservation.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReservingInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a reserving rule", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/reverting": { - "get": { - "operationId": "reverting_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reverting" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all reverting parameters", - "tags": [ - "reverting" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "reverting_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reverting" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a Reverting", - "tags": [ - "reverting" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/reverting/{id}/{version}": { - "get": { - "operationId": "reverting_getById", - "parameters": [ - { - "description": "The id to identify a Reverting", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Reverting", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reverting" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves reverting for id and version", - "tags": [ - "reverting" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "reverting_update", - "parameters": [ - { - "description": "The id to identify a Reverting", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Reverting", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reverting" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing Reverting", - "tags": [ - "reverting" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/round-trips": { - "get": { - "operationId": "round-trips_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all round trips", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "round-trips_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoundTripInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a roundtrip", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/round-trips/{id}": { - "get": { - "operationId": "round-trips_getById", - "parameters": [ - { - "description": "The unique id to identify a roundtrip", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the roundtrip", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoundTrip" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a roundtrip by id", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/round-trips/{id}/{version}": { - "get": { - "operationId": "round-trips_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a roundtrip", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the roundtrip", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoundTrip" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a roundtrip by id and version", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "round-trips_update", - "parameters": [ - { - "description": "The unique id to identify a roundtrip", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the roundtrip", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoundTripInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a round trips", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/roundings": { - "get": { - "operationId": "roundings_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rounding" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all rounding parameters", - "tags": [ - "roundings" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "roundings_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rounding" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a rounding", - "tags": [ - "roundings" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/roundings/{id}/{version}": { - "delete": { - "operationId": "roundings_deleteById", - "parameters": [ - { - "description": "The id to identify a Rounding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Rounding", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a Rounding by id and version", - "tags": [ - "roundings" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "roundings_getById", - "parameters": [ - { - "description": "The id to identify a Rounding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Rounding", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rounding" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves rounding for id and version", - "tags": [ - "roundings" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "roundings_update", - "parameters": [ - { - "description": "The id to identify a Rounding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Rounding", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rounding" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing rounding", - "tags": [ - "roundings" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/sale-discount-rights": { - "get": { - "operationId": "sale-discount-rights_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all sale discount rights", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "sale-discount-rights_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a SaleDiscountRight", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/sale-discount-rights/count": { - "get": { - "operationId": "sale-discount-rights_getCount", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Count" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of sale discount rights", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/sale-discount-rights/entitlement-given/{id}": { - "get": { - "operationId": "sale-discount-rights_getByEntitlementGivenIdWithGpaDataSet", - "parameters": [ - { - "description": "The id to identify an EntitlementGiven", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves sale discount rights by id of the entitlement given they are connected to", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/sale-discount-rights/pages": { - "get": { - "operationId": "sale-discount-rights_getPageWithGpaDataSet", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Size of page", - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Page number", - "in": "query", - "name": "pageNumber", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaleDiscountRightPageWrapper" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/sale-discount-rights/{id}": { - "get": { - "operationId": "sale-discount-rights_getByIdLatestVersionWithGpaDataSet", - "parameters": [ - { - "description": "The id to identify a SaleDiscountRight", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves newest sale discount right for id", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/sale-discount-rights/{id}/{version}": { - "delete": { - "operationId": "sale-discount-rights_deleteById", - "parameters": [ - { - "description": "The id to identify a SaleDiscountRight", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the SaleDiscountRight", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a SaleDiscountRight by id and version", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "sale-discount-rights_getByIdWithGpaDataSet", - "parameters": [ - { - "description": "The id to identify a SaleDiscountRight", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the SaleDiscountRight", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves sale discount right for id and version", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "sale-discount-rights_update", - "parameters": [ - { - "description": "The id to identify a SaleDiscountRight", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the SaleDiscountRight", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SaleDiscountRight" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing SaleDiscountRight", - "tags": [ - "sale-discount-rights" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/sales-packages": { - "get": { - "operationId": "sales-packages_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fare frame", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesPackage" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves sales packages by organisation id", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "sales-packages_create_1", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesPackageInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a salespackage", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/sales-packages/{id}": { - "get": { - "operationId": "sales-packages_getById", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesPackage" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a sales package by id", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/sales-packages/{id}/{version}": { - "get": { - "operationId": "sales-packages_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesPackage" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a sales package by id", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "sales-packages_update_1", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesPackageInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a sales-package", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/security-policy": { - "get": { - "operationId": "security-policy_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SecurityPolicy" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all security policies", - "tags": [ - "security-policy" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "security-policy_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SecurityPolicy" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a SecurityPolicy", - "tags": [ - "security-policy" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/security-policy/defaults": { - "get": { - "operationId": "security-policy_getDefaults", - "parameters": [ - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SecurityPolicy" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves default security policies", - "tags": [ - "security-policy" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/security-policy/{id}/{version}": { - "get": { - "operationId": "security-policy_getById", - "parameters": [ - { - "description": "The id to identify a SecurityPolicy", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the SecurityPolicy", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SecurityPolicy" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves security policy for id and version", - "tags": [ - "security-policy" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "security-policy_update", - "parameters": [ - { - "description": "The id to identify a SecurityPolicy", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the SecurityPolicy", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SecurityPolicy" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing SecurityPolicy", - "tags": [ - "security-policy" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/service-facility-sets": { - "get": { - "operationId": "service-facility-sets_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceFacilitySet" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all service facility sets", - "tags": [ - "service-facility-sets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "service-facility-sets_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceFacilitySet" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a ServiceFacilitySet", - "tags": [ - "service-facility-sets" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/service-facility-sets/{id}/{version}": { - "delete": { - "operationId": "service-facility-sets_deleteById", - "parameters": [ - { - "description": "The id to identify a ServiceFacilitySet", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ServiceFacilitySet", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a ServiceFacilitySet by id and version", - "tags": [ - "service-facility-sets" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "service-facility-sets_getById", - "parameters": [ - { - "description": "The id to identify a ServiceFacilitySet", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ServiceFacilitySet", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceFacilitySet" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves service facility set for id and version", - "tags": [ - "service-facility-sets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "service-facility-sets_update", - "parameters": [ - { - "description": "The id to identify a ServiceFacilitySet", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ServiceFacilitySet", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceFacilitySet" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing ServiceFacilitySet", - "tags": [ - "service-facility-sets" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/supplement-products": { - "get": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_getAll_1", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to idetify data owned by organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "the unique id for the language", - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupplementProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a supplement products by organisation id", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_create_1", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupplementProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a SupplementProduct", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/supplement-products/{id}": { - "get": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_getById", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupplementProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of supplement products by id", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/supplement-products/{id}/refunding": { - "get": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_getRefundingByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a fareProduct", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "the unique id for the language", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version of the fareProduct", - "in": "query", - "name": "productVersionId", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refunding" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives refunding rules by fare product id and version", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/supplement-products/{id}/{version}": { - "get": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupplementProduct" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of supplement product by id and version", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_update_1", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the fare structure element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupplementProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a supplement product parameter.", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/tariffs": { - "post": { - "operationId": "tariffs_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TariffInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a tariff", - "tags": [ - "tariffs" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/tariffs/{id}/{version}": { - "get": { - "operationId": "tariffs_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a tariff", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the tariff", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tariff" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a tariff by id", - "tags": [ - "tariffs" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/text-in-language/{id}/{version}": { - "put": { - "operationId": "text-in-language_update", - "parameters": [ - { - "description": "The unique id to identify the entity", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the entity", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NameAndDescription" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity set successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create or update name and description on an entity", - "tags": [ - "text-in-language" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/timebands": { - "get": { - "operationId": "timebands_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Timeband" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all time bands", - "tags": [ - "timebands" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "timebands_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Timeband" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a time band", - "tags": [ - "timebands" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/timebands/{id}/{version}": { - "get": { - "operationId": "timebands_getById", - "parameters": [ - { - "description": "The id to identify a Timeband", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Timeband", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Timeband" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves time band for id and version", - "tags": [ - "timebands" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "timebands_update", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "path", - "name": "version", - "required": true, - "schema": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Timeband" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a time band", - "tags": [ - "timebands" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/transferabilities": { - "get": { - "operationId": "transferabilities_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all transferabilities", - "tags": [ - "transferabilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "transferabilities_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transferability" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a transferability", - "tags": [ - "transferabilities" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/transferabilities/{id}/{version}": { - "get": { - "operationId": "transferabilities_getById", - "parameters": [ - { - "description": "The id to identify a Transferability", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Transferability", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transferability" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferabilities for id and version", - "tags": [ - "transferabilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "transferabilities_update", - "parameters": [ - { - "description": "The id to identify a Transferability", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the Transferability", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transferability" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing Transferability", - "tags": [ - "transferabilities" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/transferability-possibilities": { - "post": { - "operationId": "transferability-possibilities_getTransferabilityPossibilities", - "parameters": [ - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransferabilityAlternatives" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransferabilityAlternatives" - } - } - } - }, - "description": "Returns the resource." - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferability rules for given elements", - "tags": [ - "transferability-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/transferability-possibilities/fare-structure-element/{id}/{version}": { - "get": { - "operationId": "transferability-possibilities_getFSETransferabilityPossibilities", - "parameters": [ - { - "description": "The id to identify a fare structure element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferability rules for given elements", - "tags": [ - "transferability-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/transferability-possibilities/preassigned-product/{id}/{version}": { - "get": { - "operationId": "transferability-possibilities_getFPTransferabilityPossibilities", - "parameters": [ - { - "description": "The id to identify a product.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferability rules for given elements", - "tags": [ - "transferability-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/transferability-possibilities/sales-package/{id}/{version}": { - "get": { - "operationId": "transferability-possibilities_getSPTransferabilityPossibilities", - "parameters": [ - { - "description": "The unique id to identify a sales package.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferability rules for given elements", - "tags": [ - "transferability-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/transferability-possibilities/validable-element/{id}/{version}": { - "get": { - "operationId": "transferability-possibilities_getVETransferabilityPossibilities", - "parameters": [ - { - "description": "The id to identify a validable element.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the element.", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code for the name and description fields.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The id of the distribution channel.", - "in": "header", - "name": "Entur-Distribution-Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves transferability rules for given elements", - "tags": [ - "transferability-possibilities" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/type-of-concession": { - "get": { - "operationId": "type-of-concession_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fareframe", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeOfConcession" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves typeOfConcession by fareframe id or organisation id", - "tags": [ - "type-of-concession" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/type-of-concession/{id}": { - "get": { - "operationId": "type-of-concession_getById", - "parameters": [ - { - "description": "The unique id to identify a typeOfConcession", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the typeOfConcession", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfConcession" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a typeOfConcession by id", - "tags": [ - "type-of-concession" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/type-of-concession/{id}/{version}": { - "get": { - "operationId": "type-of-concession_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a typeOfConcession", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the typeOfConcession", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfConcession" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a typeOfConcession by id and version", - "tags": [ - "type-of-concession" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "type-of-concession_update", - "parameters": [ - { - "description": "The unique id to identify a typeOfConcession", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the typeOfConcession", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfConcessionInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a type of concession", - "tags": [ - "type-of-concession" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/type-of-fare-products": { - "get": { - "operationId": "type-of-fare-products_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfFareProduct" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of fare products by organisationId or fareFrameId", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "type-of-fare-products_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfFareProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create type of fare product", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/type-of-fare-products/{id}": { - "get": { - "operationId": "type-of-fare-products_getById", - "parameters": [ - { - "description": "The unique id to identify a type of fare product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfFareProduct" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of fare product by id", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/type-of-fare-products/{id}/{version}": { - "get": { - "operationId": "type-of-fare-products_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a type of fare product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfFareProduct" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of fare product by id", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "type-of-fare-products_update", - "parameters": [ - { - "description": "The unique id to identify a type of fare product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfFareProductInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a type of fare product", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/type-of-responsibility-role": { - "get": { - "operationId": "type-of-responsibility-role_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieve all typeOfResponsibilityRoles", - "tags": [ - "type-of-responsibility-role" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/type-of-usage-parameters": { - "get": { - "operationId": "type-of-usage-parameters_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfUsageParameter" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all type of usage parameters.", - "tags": [ - "type-of-usage-parameters" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "type-of-usage-parameters_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfUsageParameterInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create type of usage parameter ", - "tags": [ - "type-of-usage-parameters" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/type-of-usage-parameters/{id}/{version}": { - "get": { - "operationId": "type-of-usage-parameters_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a type of usage parameters", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "version", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TypeOfUsageParameter" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of usage parameter by id and version", - "tags": [ - "type-of-usage-parameters" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/usage-validity-periods": { - "get": { - "operationId": "usage-validity-periods_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fare frame", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UsageValidityPeriod" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves usage validity periods by organisation id", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "usage-validity-periods_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsageValidityPeriodInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a usage validity parameter", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/usage-validity-periods/batch": { - "post": { - "operationId": "usage-validity-periods_createMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a list of uvp", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "put": { - "operationId": "usage-validity-periods_updateMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a list of uvps", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/usage-validity-periods/{id}": { - "get": { - "operationId": "usage-validity-periods_getById", - "parameters": [ - { - "description": "The unique id to identify a usage validity period", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the usage validity period", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsageValidityPeriod" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a usage validity period by id", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/usage-validity-periods/{id}/{version}": { - "get": { - "operationId": "usage-validity-periods_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a usage validity period", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the usage validity period", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsageValidityPeriod" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a usage validity period by id", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "usage-validity-periods_update", - "parameters": [ - { - "description": "The unique id to identify a usage validity period", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the usage validity period", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsageValidityPeriodInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a usage validity period", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/user-profiles": { - "get": { - "operationId": "user-profiles_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserProfile" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all user profile", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "user-profiles_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserProfileInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a userprofile", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/user-profiles/{id}": { - "get": { - "operationId": "user-profiles_getById", - "parameters": [ - { - "description": "The unique id to identify a userprofile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the userprofile", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserProfile" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a userprofile by id", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/user-profiles/{id}/{version}": { - "get": { - "operationId": "user-profiles_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a userprofile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the userprofile", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserProfile" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a userprofile by id and version", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "user-profiles_update", - "parameters": [ - { - "description": "The unique id to identify a userprofile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the userprofile", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserProfileInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a user profile", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/uvp-for-number-of-zones": { - "get": { - "operationId": "uvp-for-number-of-zones_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify dataset to an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UVPForNumberOfZones" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "uvp-for-number-of-zones", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "uvp-for-number-of-zones_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a uvpForNumberOfZones", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/uvp-for-number-of-zones/batch": { - "post": { - "operationId": "uvp-for-number-of-zones_createMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a list of uvp for number of zones", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "put": { - "operationId": "uvp-for-number-of-zones_updateMany", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a list of uvpForZones", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/uvp-for-number-of-zones/{id}/{version}": { - "get": { - "operationId": "uvp-for-number-of-zones_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a UVPForNumberOfZones", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the UVPForNumberOfZones", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UVPForNumberOfZones" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a UVPForNumberOfZones by id", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "uvp-for-number-of-zones_update", - "parameters": [ - { - "description": "The unique id to identify a UVPForNumberOfZones", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the UVPForNumberOfZones", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a uvpForNumberOfZones", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v1/charging-moments/{id}": { - "get": { - "operationId": "charging-moment-controller-v-1_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a charging moment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the charging moment", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the charging moments version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the charging moments version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ChargingMoment" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a charging moment by id", - "tags": [ - "charging-moment-controller-v-1" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/companion-profiles/{id}": { - "get": { - "deprecated": true, - "operationId": "companion-profiles_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a companion profile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the companion profile", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the companion profiles version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the companion profiles version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CompanionProfile" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a companion profile by id", - "tags": [ - "companion-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/distance-matrix-elements/{id}": { - "get": { - "operationId": "distance-matrix-elements_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a distance matrix elment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the distance matrix elment", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the distance matrix elments version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the distance matrix elments version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DistanceMatrixElement" - } - } - } - }, - "description": "Returns the distance matrix elment" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a distance matrix elment by id", - "tags": [ - "distance-matrix-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/exchanging/{id}": { - "get": { - "operationId": "exchanging_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a exchanging", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the exchanging rule", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the exchanging rules version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the exchanging rules version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "summary": "Retrieves a exchanging rule by id", - "tags": [ - "exchanging" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/fare-frames/{id}": { - "get": { - "operationId": "fare-frames_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a fare frames", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the fare frame", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the fare frames version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the fare frames version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareFrame" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a fare frames by id", - "tags": [ - "fare-frames" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/fare-structure-elements/{id}": { - "get": { - "operationId": "fare-structure-elements_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a fare structure element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the fare structure element", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the fare structure elements version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the fare structure elements version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareStructureElement" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a fare structure element by netexId", - "tags": [ - "fare-structure-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/fare-tables/{id}": { - "get": { - "operationId": "fare-tables_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a fare table", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the fare table", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "if set to true fare table cells will be omitted", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the fare tables version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the fare tables version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FareTable" - } - } - } - }, - "description": "Returns the fare table" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a fare table by id", - "tags": [ - "fare-tables" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/frequencies-of-use/{id}": { - "get": { - "operationId": "frequencies-of-use_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a frequency of use", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the frequency of use", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the frequency of use version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the frequency of use version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FrequencyOfUse" - } - } - } - }, - "description": "Returns the frequencies of use" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves frequencies of use by id", - "tags": [ - "frequencies-of-use" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/generic-parameter-assignments/{id}": { - "get": { - "operationId": "generic-parameter-assignments_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a generic parameter assignment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the generic parameter assignment", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the generic parameter assignments version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the generic parameter assignments version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a generic parameter assignment by id", - "tags": [ - "generic-parameter-assignments" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/geographical-intervals/{id}": { - "get": { - "operationId": "geographical-intervals_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a geographical interval", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the geographical interval", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the geographical intervals version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the geographical intervals version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GeographicalInterval" - } - } - } - }, - "description": "Returns the geographical interval" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a geographical interval by id", - "tags": [ - "geographical-intervals" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/group-tickets/{id}": { - "get": { - "operationId": "group-tickets_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a group ticket", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the group ticket", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the group tickets version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the group tickets version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupTicket" - } - } - } - }, - "description": "Returns the group ticket" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a group ticket by id", - "tags": [ - "group-tickets" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/interchangings/{id}": { - "get": { - "operationId": "interchangings_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a group ticket", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the interchaning", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the interchaning version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the interchaning version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Interchanging" - } - } - } - }, - "description": "Returns interchaning" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves an interchanging by id", - "tags": [ - "interchangings" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/preassigned-products/{id}": { - "get": { - "operationId": "preassigned-products_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the product", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the products version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the products version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PreassignedFareProduct" - } - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of preassignedFareProduct by id", - "tags": [ - "preassigned-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/purchase-windows/{id}": { - "get": { - "operationId": "purchase-windows_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a purchase window", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the purchase window", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the purchase windows version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the purchase windows version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PurchaseWindow" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a purchase window by id", - "tags": [ - "purchase-windows" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/refunding/{id}": { - "get": { - "operationId": "refunding_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a refunding", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the refunding rule", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the refunding rules version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the refunding rules version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Refunding" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a refunding rule by id", - "tags": [ - "refunding" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/reserving/{id}": { - "get": { - "operationId": "reserving_getByIdV2", - "parameters": [ - { - "description": "The unique ID to identify a reserving.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3.", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the reserving rule.", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the reserving rule version.", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the reserving rule version.", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reserving" - } - } - } - }, - "description": "Returns the reserving rule." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a reserving rule by ID", - "tags": [ - "reserving" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/round-trips/{id}": { - "get": { - "operationId": "round-trips_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a round trips", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the round trips", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the round trips version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the round tripss version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RoundTrip" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a round trips by id", - "tags": [ - "round-trips" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/sales-packages/{id}": { - "get": { - "operationId": "sales-packages_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the sales package", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the sales packages version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the sales packages version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesPackage" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a sales package by id", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/supplement-products/{id}": { - "get": { - "deprecated": true, - "description": "This API is deprecated and will be removed in future releases. Please migrate to the new API version. New api will support all supplementProductTypeEnums according to the netex-standard", - "operationId": "supplement-products_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the product", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the products version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the products version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupplementProduct" - } - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the latest version of supplement product by id", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/tariffs/{id}": { - "get": { - "operationId": "tariffs_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a tariff", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the tariff", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the tariffs version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the tariffs version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tariff" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a tariff by id", - "tags": [ - "tariffs" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/type-of-concession/{id}": { - "get": { - "operationId": "type-of-concession_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a type of concession", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the type of concession", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the type of concessions version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the type of concessions version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeOfConcession" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives a type of concession by id", - "tags": [ - "type-of-concession" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/type-of-fare-products/{id}": { - "get": { - "operationId": "type-of-fare-products_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a type of fare product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the type of fare product", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the type of fare products version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the type of fare products version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeOfFareProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of fare product by id", - "tags": [ - "type-of-fare-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/type-of-usage-parameters/{id}": { - "get": { - "operationId": "type-of-usage-parameters_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a type of usage parameters", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the type of usage parameters", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the type of usage parameters version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the type of usage parameter version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TypeOfUsageParameter" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves type of usage parameter by id", - "tags": [ - "type-of-usage-parameters" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/usage-validity-periods/{id}": { - "get": { - "operationId": "usage-validity-periods_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a usage validity period", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the usage validity period", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the usage validity periods version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the usage validity periods version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UsageValidityPeriod" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a usage validity period by id", - "tags": [ - "usage-validity-periods" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/user-profiles/{id}": { - "get": { - "operationId": "user-profiles_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a user profile", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the user profile", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the user profiles version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the user profiles version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserProfile" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a user profile by id", - "tags": [ - "user-profiles" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/uvp-for-number-of-zones/{id}": { - "get": { - "operationId": "uvp-for-number-of-zones_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a charging moment", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the charging moment", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the charging moments version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the charging moments version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UVPForNumberOfZones" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a uvpForNumberOfZones by id", - "tags": [ - "uvp-for-number-of-zones" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/valid-betweens/{id}": { - "get": { - "deprecated": true, - "operationId": "valid-betweens_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a validBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "Languagecode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the validBetween", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the validBetween version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the validBetween version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidBetween" - } - } - } - }, - "description": "Returns the valid between" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrives valid betweens by id for a given date. This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v1/validable-elements/{id}": { - "get": { - "operationId": "validable-elements_getByIdV2", - "parameters": [ - { - "description": "The unique id to identify a validable element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The version status of the validable element", - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The from date of the validable elements version", - "in": "query", - "name": "fromDate", - "schema": { - "type": "string" - } - }, - { - "description": "The to date of the validable elements version", - "in": "query", - "name": "toDate", - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidableElement" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable elements by id and latest version", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v2/sales-packages": { - "get": { - "operationId": "sales-packages_getAllWithGpaDataSetAndStatusFilter", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/v2.SalesPackage" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all sales packages", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "sales-packages_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SalesPackage" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a sales package", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v2/sales-packages/count": { - "get": { - "operationId": "sales-packages_count", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int32" - } - } - }, - "description": "Returns the number of sales packages" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of sales packages", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v2/sales-packages/pages": { - "get": { - "operationId": "sales-packages_pages", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of sales packages per page", - "in": "query", - "name": "pageSize", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The page number", - "in": "query", - "name": "pageNumber", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesPackagePageWrapper" - } - } - }, - "description": "Returns the number of pages of sales packages" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of pages of sales packages", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v2/sales-packages/{id}/{version}": { - "delete": { - "operationId": "sales-packages_deleteById", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the sales package", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Entity deleted successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Delete a sales package given id and version", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "sales-packages_getByIdWithGpaDataSet", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the sales package", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SalesPackage" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves sales package given id and version", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "sales-packages_update", - "parameters": [ - { - "description": "The unique id to identify a sales package", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The version of the sales package", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SalesPackage" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing sales package", - "tags": [ - "sales-packages" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v2/supplement-products": { - "get": { - "operationId": "supplement-products_getAll", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Possibility of opting out of including child elements", - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all supplement products", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "supplement-products_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - }, - "description": "Returns the created supplement product" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Creates a new supplement product", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v2/supplement-products/{id}/versions": { - "get": { - "operationId": "supplement-products_getVersionsOrActiveById", - "parameters": [ - { - "description": "The id to identify a supplement product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", - "in": "query", - "name": "active", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all versions of a supplement product", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v2/supplement-products/{id}/{version}": { - "get": { - "operationId": "supplement-products_getByIdWithGpaDataSet", - "parameters": [ - { - "description": "The id to identify a supplement product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the supplement product", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - }, - "description": "Returns the supplement product" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves a supplement product by id and version", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "supplement-products_update", - "parameters": [ - { - "description": "The id to identify a supplement product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the supplement product", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/v2.SupplementProduct" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing supplement product", - "tags": [ - "supplement-products" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v2/valid-betweens": { - "get": { - "operationId": "valid-betweens_getAll_1", - "parameters": [ - { - "description": "The unique id to identify an organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "minimizeDataLoad", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidBetween" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all valid betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "valid-betweens_create_1", - "parameters": [ - { - "in": "header", - "name": "X-Correlated-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetween" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a validBetween", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/v2/valid-betweens/{id}": { - "get": { - "operationId": "valid-betweens_getById_1", - "parameters": [ - { - "description": "The id to identify a ValidBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetween" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves active valid between for id", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/v2/valid-betweens/{id}/{version}": { - "delete": { - "operationId": "valid-betweens_deleteById_1", - "parameters": [ - { - "description": "The id to identify a ValidBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ValidBetween", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlated-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoxedUnit" - } - } - }, - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a valid between by id and version", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "operationId": "valid-betweens_getById", - "parameters": [ - { - "description": "The id to identify a ValidBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ValidBetween", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetween" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves valid between for id and version", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "valid-betweens_update_1", - "parameters": [ - { - "description": "The id to identify a ValidBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ValidBetween", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlated-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetween" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Updates an existing ValidBetween", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/valid-betweens": { - "get": { - "deprecated": true, - "operationId": "valid-betweens_getAll", - "parameters": [ - { - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset for an organization", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PenaltyPolicyAlternatives" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all valid betweens for a given fare frame. This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "deprecated": true, - "operationId": "valid-betweens_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetweenInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a validBetween. This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/valid-betweens/{id}/{version}": { - "delete": { - "deprecated": true, - "operationId": "valid-betweens_deleteById", - "parameters": [ - { - "description": "The id to identify a ValidBetween", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id for the version of the ValidBetween", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The resource was deleted" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Deletes a ValidBetween by id and version. This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - }, - "get": { - "deprecated": true, - "operationId": "valid-betweens_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a validable element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the given validable element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "header", - "name": "Accept-Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetween" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable between by id and version. This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "deprecated": true, - "operationId": "valid-betweens_update", - "parameters": [ - { - "description": "The unique id to identify the valid between", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the valid between", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidBetweenInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a valid between. . This api is deprecated, use .../v2/valid-betweens", - "tags": [ - "valid-betweens" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/validable-elements": { - "get": { - "operationId": "validable-elements_getAll", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fare frame", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidableElement" - } - } - } - }, - "description": "Returns the resources" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable elements by organisation id or fareframe", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "post": { - "operationId": "validable-elements_create", - "parameters": [ - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidableElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Already registered" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create a validable-element", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/validable-elements-usages/{id}": { - "get": { - "operationId": "validable-elements-usages_getById", - "parameters": [ - { - "description": "The netex_id to identify a validable element ", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementUsages" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves references where the given validable element id is referenced", - "tags": [ - "validable-elements-usages" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/validable-elements/count": { - "get": { - "operationId": "validable-elements_getCount", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fare frame", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int32" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/validable-elements/pages": { - "get": { - "operationId": "validable-elements_findPagesByOrganisationIdOrFareFrameId", - "parameters": [ - { - "description": "The unique id to identify a organisation", - "in": "query", - "name": "orgId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a fare frame", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of elements to return", - "in": "query", - "name": "pageSize", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "The offset to start from", - "in": "query", - "name": "pageNumber", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", - "example": [ - "DRAFT", - "PROPOSED" - ], - "in": "query", - "name": "statusFilter", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidableElementPageWrapper" - } - } - }, - "description": "Returns the resources" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable elements by organisation id or fareframe", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/validable-elements/{id}": { - "get": { - "operationId": "validable-elements_getById", - "parameters": [ - { - "description": "The unique id to identify a validable element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the given validable element", - "in": "query", - "name": "version", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidableElement" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable elements by id and latest version", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/validable-elements/{id}/{version}": { - "get": { - "operationId": "validable-elements_getByIdAndVersion", - "parameters": [ - { - "description": "The unique id to identify a validable element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the given validable element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Type of gpa dataset", - "in": "query", - "name": "gpaDataSet", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidableElement" - } - } - }, - "description": "Returns the resource" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves validable elements by id and version", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "validable-elements_update", - "parameters": [ - { - "description": "The unique id to identify a validable element", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The id of the version of the given validable element", - "in": "path", - "name": "version", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidableElementInsert" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Update a validable element", - "tags": [ - "validable-elements" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/vat-register": { - "get": { - "operationId": "vat-register_getAllVatRegisters", - "parameters": [ - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VatRegister" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves all vat registers", - "tags": [ - "vat-register" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/vat-register/{vatGroup}": { - "get": { - "operationId": "vat-register_getVatRegisters", - "parameters": [ - { - "description": "The identifier for a VAT", - "in": "path", - "name": "vatGroup", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VatRegister" - } - } - } - }, - "description": "Returns the resource." - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found." - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves vat register for group", - "tags": [ - "vat-register" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/versions": { - "post": { - "operationId": "versions_create", - "parameters": [ - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Version" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Entity created successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Not Found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Create version", - "tags": [ - "versions" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - }, - "/versions/batch": { - "post": { - "operationId": "versions_getVersionsByObjectIds", - "parameters": [ - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VersionBatchRetrieve" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Version" - } - } - } - }, - "description": "Returns the info" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get all versions", - "tags": [ - "versions" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/versions/element-type/{nameOfClass}": { - "get": { - "operationId": "versions_getMinimalVersionInfoByClassOfName", - "parameters": [ - { - "description": "The unique class name to identify for an elementType", - "in": "path", - "name": "nameOfClass", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a dataset to an organisation", - "in": "query", - "name": "fareFrameId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MininmalVersionInfo" - } - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Forbidden" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Retrieves metadata of specific element type by class name", - "tags": [ - "versions" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - } - }, - "/versions/{id}": { - "get": { - "operationId": "versions_getById", - "parameters": [ - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The netex id to identify a version entry", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - }, - { - "description": "The language code from ISO-639-3", - "in": "query", - "name": "languageCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", - "in": "header", - "name": "If-None-Match", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Version" - } - } - }, - "description": "Returns the info" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Bad Request" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Unauthorized" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Get version for netexid", - "tags": [ - "versions" - ], - "x-entur-permissions": { - "value": "product-api-access:les" - } - }, - "put": { - "operationId": "versions_updateVersionStatus", - "parameters": [ - { - "in": "header", - "name": "Et-Client-Name", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Correlation-Id", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id to identify a version of a product", - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Version" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Entity updated successfully" - }, - "400": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Validation errors" - }, - "401": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Missing Authorization" - }, - "403": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Authorization failed" - }, - "404": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Resource not found" - }, - "409": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Conflict" - }, - "500": { - "content": { - "application/problem+json": { - "schema": { - "type": "string" - } - } - }, - "description": "Internal server error" - } - }, - "security": [ - { - "basic_auth": [] - } - ], - "summary": "Set the status of a product version by id", - "tags": [ - "versions" - ], - "x-entur-permissions": { - "value": "product-api-access:endre" - } - } - } - }, - "components": { - "schemas": { - "AccessRightInProduct": { - "required": [ - "fareFrameRef", - "id", - "preassignedFareProductRef", - "validableElementRef", - "version" - ], - "type": "object", - "properties": { - "accessNumber": { - "type": "integer", - "description": "The actual access number", - "format": "int32" - }, - "accessNumberIsLimited": { - "type": "boolean", - "description": "Flag indicating if access number is limited" - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:AccessRightInProduct:Ordinary" - }, - "isFirstInSequence": { - "type": "boolean", - "description": "Whether element is first in sequence" - }, - "isLastInSequence": { - "type": "boolean", - "description": "Whether element is last in sequence" - }, - "limitedAccessNumber": { - "type": "integer", - "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", - "format": "int32" - }, - "maximumAccess": { - "type": "integer", - "description": "Maximum number of times use of this element may occur in a given trip", - "format": "int32" - }, - "minimumAccess": { - "type": "integer", - "description": "Minimum number of times use of this element must occur in a given trip", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "Refunding" - }, - "orderOfElement": { - "type": "integer", - "description": "The actual order in the sequence", - "format": "int32" - }, - "preassignedFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Access right in product status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Access right in product version.", - "example": "NSB:Version:V1" - } - }, - "description": "A VALIDABLE ELEMENT as a part of a PRE-ASSIGNED FARE PRODUCT, including its possible order in the set of all VALIDABLE ELEMENTs grouped together to define the access right assigned to that PRE-ASSIGNED FARE PRODUCT." - }, - "AccessRightInProductInsert": { - "required": [ - "fareFrameRef", - "id", - "preassignedFareProductRef", - "validableElementRef" - ], - "type": "object", - "properties": { - "accessNumber": { - "type": "integer", - "description": "The actual access number", - "format": "int32" - }, - "accessNumberIsLimited": { - "type": "boolean", - "description": "Flag indicating if access number is limited" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:AccessRightInProduct:Ordinary" - }, - "isFirstInSequence": { - "type": "boolean", - "description": "Whether element is first in sequence" - }, - "isLastInSequence": { - "type": "boolean", - "description": "Whether element is last in sequence" - }, - "maximumAccess": { - "type": "integer", - "description": "Maximum number of times use of this element may occur in a given trip", - "format": "int32" - }, - "minimumAccess": { - "type": "integer", - "description": "Minimum number of times use of this element must occur in a given trip", - "format": "int32" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "orderOfElement": { - "type": "integer", - "description": "The actual order in the sequence", - "format": "int32" - }, - "preassignedFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - } - }, - "Accommodation": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "accommodationFacility": { - "type": "string", - "description": "Accommodation facility.", - "example": "SLEEPER", - "enum": [ - "SLEEPER", - "SEATING", - "DOUBLE_SLEEPER", - "SINGLE_SLEEPER", - "SPECIAL_SLEEPER", - "COUCHETTE", - "SINGLE_COUCHETTE", - "DOUBLE_COUCHETTE", - "RECLINING_SEAT", - "BABY_COMPARTMENT", - "FAMILY_COMPARTMENT", - "PANORAMA_COACH", - "PULLMAN_COACH", - "STANDING" - ] - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Accommodation:Sleeper" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "Accommodation" - }, - "nuisanceFacilities": { - "type": "array", - "description": "List of nuisance facilities", - "items": { - "type": "string" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "An Accommodation" - }, - "AmountOfPriceUnitProduct": { - "required": [ - "amount", - "chargingMoment", - "chargingMomentRef", - "fareFrameRef", - "id", - "modification", - "productType", - "status" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "AccessRightParameterAssignmentRefs.", - "writeOnly": true, - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "accessRightParameterAssignments": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "amount": { - "minimum": 1, - "type": "integer", - "description": "Amount. Must be greater than 0.", - "format": "int32", - "example": 10 - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef", - "readOnly": true - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:AmountOfPriceUnitProduct:RuterCarnetTicket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "AmountOfPriceUnitProduct" - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "productType": { - "type": "string", - "description": "AmountOfPriceUnitProductType.", - "example": "TRIP_CARNET", - "enum": [ - "TRIP_CARNET", - "PASS_CARNET", - "UNIT_COUPON", - "STORED_VALUE", - "OTHER" - ] - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "An Amount Of Price Unit Product response" - }, - "AreaValidity": { - "required": [ - "changed", - "created", - "id", - "minimumZonesForAreaValidity", - "modification", - "nameOfClass", - "status", - "typeOfAreaValidity", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "groupOfTariffZoneRef": { - "type": "string", - "description": "Group of tariff zone", - "example": "ENT:GroupOfTariffZone:abcdef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:AreaValidity:RuterSingleTicket" - }, - "minimumZonesForAreaValidity": { - "type": "integer", - "description": "Minimum no. of zones for area validity.", - "format": "int32", - "example": 5 - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "AreaValidity" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfAreaValidity": { - "type": "string", - "description": "Type of area validity", - "example": "RING", - "deprecated": true, - "enum": [ - "POINT_TO_POINT", - "RING" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "readOnly": true, - "example": "RUT:Version:V1" - } - }, - "description": "Requirements for area validity." - }, - "AvailabilityCondition": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fromDate", - "id", - "isAvailable", - "modification", - "nameOfClass", - "status", - "toDate", - "version" - ], - "type": "object", - "properties": { - "available": { - "type": "boolean" - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "dayTypeRefs": { - "type": "array", - "description": "Day Type references.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fromDate": { - "type": "string", - "description": "FromDate datetime." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:AvailabilityCondition:SomeId" - }, - "isAvailable": { - "type": "boolean", - "description": "Is available" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "AvailabilityCondition" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "timebandRefs": { - "type": "array", - "description": "Time band references.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "toDate": { - "type": "string", - "description": "toDate datetime." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "AvailabilityCondition version.", - "example": "ENT:Version:SomeVersion" - } - }, - "description": "An AvailabilityCondition" - }, - "BoxedUnit": { - "type": "object" - }, - "CappedDiscountRight": { - "required": [ - "changed", - "chargingMoment", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "validityConditions", - "vatGroupRegister", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "cappingRules": { - "type": "array", - "description": "Capping rules.", - "items": { - "$ref": "#/components/schemas/CappingRule" - } - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:CappedDiscountRight:BestePrisFylket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "CappedDiscountRight" - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validationRequirements": { - "type": "string", - "description": "An optional set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", - "example": "[\"IDENTIFIABLE_CUSTOMER\"]" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister.", - "example": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A Capped Discount Right response" - }, - "CappedDiscountRightInsert": { - "required": [ - "chargingMomentRef", - "fareFrameRef", - "id", - "name", - "operatorRef", - "organisation", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProductInsert" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "cappingRules": { - "type": "array", - "description": "Capping rules.", - "items": { - "$ref": "#/components/schemas/CappingRuleInsert" - } - }, - "chargingMomentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummaryInsert" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:CappedDiscountRight:BestePrisFylket" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Organisation." - }, - "prices": { - "type": "array", - "description": "Prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "typeOfFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validationRequirements": { - "type": "string", - "description": "A set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", - "example": "[\"IDENTIFIABLE_CUSTOMER\"]" - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister.", - "default": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "CappingRule": { - "required": [ - "activeComparisonOperatorVariant", - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "Access Right Parameter assignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether a gpa belongs to A or E gpa implementation.", - "example": "A" - }, - "cappingPeriod": { - "type": "string", - "description": "Period over which capping applies.", - "example": "DAY", - "enum": [ - "DAY", - "WEEK", - "MONTH" - ] - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "Reference to fare table.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:CappingRule:EnkeltbillettTil24Timer" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "CappingRule" - }, - "preassignedFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "prices": { - "type": "array", - "description": "Prices for the fare.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "CappingRuleInsert": { - "required": [ - "accessRightParameterAssignmentRefs", - "activeComparisonOperatorVariant", - "fareFrameRef", - "fareTableRefs", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "Access Right Parameter assignment references.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether a gpa belongs to A or E gpa implementation.", - "example": "A" - }, - "cappingPeriod": { - "type": "string", - "description": "Period over which capping applies.", - "example": "DAY", - "enum": [ - "DAY", - "WEEK", - "MONTH" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:CappingRule:EnkeltbillettTil24Timer" - }, - "name": { - "type": "array", - "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "preassignedFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "Cell": { - "required": [ - "changed", - "created", - "farePrice", - "id", - "modification", - "nameOfClass", - "priceableObjectRefs", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "channelGroupRef": { - "type": "object", - "description": "Channel group reference" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "farePrice": { - "$ref": "#/components/schemas/FarePrice" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:Cell:5zoneAdult" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Cell" - }, - "priceableObjectRefs": { - "type": "array", - "description": "References to for example geographical interval and UserProfile", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "CellInsert": { - "required": [ - "fareFrameRef", - "farePrice", - "id", - "name" - ], - "type": "object", - "properties": { - "channelGroupRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "farePrice": { - "$ref": "#/components/schemas/FarePriceInsert" - }, - "fareTableRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:Cell:5zoneAdult" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "priceableObjectRefs": { - "type": "array", - "description": "References to for example geographical interval and UserProfile", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "version": { - "type": "string" - } - } - }, - "ChargingMoment": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ChargingMoment:Prepaid" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "ChargingMoment" - }, - "status": { - "type": "string", - "description": "Charging moment status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Charging moment version.", - "example": "NSB:Version:V1" - } - }, - "description": "A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.", - "readOnly": true, - "deprecated": true - }, - "ChargingMomentInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ChargingMoment:Prepaid" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "version": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Charging moment version.", - "example": "NSB:Version:V1" - } - } - }, - "ChargingPolicy": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "billingPolicy": { - "type": "string", - "description": "TravelBillingPolicy is optional. No default value", - "enum": [ - "BILL_AS_YOU_GO", - "BILL_ON_THRESHOLD", - "BILL_AT_FARE_DAY_END", - "BILL_AT_PERIOD_END" - ] - }, - "changed": { - "type": "string", - "description": "ChargingPolicy changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "ChargingPolicy create datetime.", - "readOnly": true - }, - "creditPolicy": { - "type": "string", - "description": "Travel credit policy enum is optional. No default value", - "enum": [ - "ALLOW_TRAVEL", - "BLOCK_PAY_AS_YOU_GO_TRAVEL", - "BLOCK_ALL_TRAVEL", - "OTHER" - ] - }, - "description": { - "type": "array", - "description": "ChargingPolicy description in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "expireAfterPeriod": { - "type": "string", - "description": "Expire after period. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ChargingPolicy:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "ChargingPolicy name in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "ChargingPolicy" - }, - "paymentGracePeriod": { - "type": "string", - "description": "Payment grace period. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "type of UsageParameter." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A ChargingPolicy response" - }, - "CompanionProfile": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "discountBasis": { - "type": "string", - "description": "Basis for discount.", - "example": "DISCOUNT", - "enum": [ - "NONE", - "FREE", - "DISCOUNT", - "FULLRATE" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the companion profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "generalGroupOfEntities": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:CompanionProfile:Adult" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "maximumNumberOfPersons": { - "type": "integer", - "description": "Maximum number of allowed companions.", - "format": "int32" - }, - "minimumNumberOfPersons": { - "type": "integer", - "description": "Minimum number of allowed companions.", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "CompanionProfile" - }, - "parentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "prices": { - "type": "array", - "description": "Fare prices for the companion profile.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "ticketing": { - "type": "string", - "description": "The type of way that tickets are issued to the group.", - "example": "SEPARATE_TICKETS", - "deprecated": true, - "enum": [ - "ALL_ON_ONE_TICKET", - "SEPARATE_TICKETS", - "TICKET_WITH_COUPONS", - "OTHER" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "userProfileId": { - "type": "string", - "description": "A user profile defining a category of people eligible to be a companion." - }, - "userProfileRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the companion profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "The version of the companion profile.", - "example": "NSB:Version:V1" - } - }, - "description": "A companion profile" - }, - "CompanionProfileInject": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "discountBasis": { - "type": "string", - "description": "Basis for discount.", - "example": "DISCOUNT", - "enum": [ - "NONE", - "FREE", - "DISCOUNT", - "FULLRATE" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "generalGroupOfEntities": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:CompanionProfile:Adult" - }, - "maximumNumberOfPersons": { - "type": "integer", - "description": "Maximum number of allowed companions.", - "format": "int32" - }, - "minimumNumberOfPersons": { - "type": "integer", - "description": "Minimum number of allowed companions.", - "format": "int32" - }, - "name": { - "type": "array", - "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "parentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "prices": { - "type": "array", - "description": "Fare prices for the companion profile.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "ticketing": { - "type": "string", - "description": "The type of way that tickets are issued to the group.", - "example": "SEPARATE_TICKETS", - "deprecated": true, - "enum": [ - "ALL_ON_ONE_TICKET", - "SEPARATE_TICKETS", - "TICKET_WITH_COUPONS", - "OTHER" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "userProfileId": { - "type": "string", - "description": "A user profile defining a category of people eligible to be a companion." - }, - "userProfileRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "The version of the companion profile.", - "example": "NSB:Version:V1" - } - }, - "description": "A companion profile create request" - }, - "ConditionSummary": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ConditionSummary:1005TEN" - }, - "isExchangeable": { - "type": "boolean", - "description": "Whether the ticket is exchangeable.", - "example": true - }, - "isRefundable": { - "type": "boolean", - "description": "Whether the ticket is refundable.", - "example": true - } - }, - "description": "A summary of a condition." - }, - "ConditionSummaryInsert": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ConditionSummary:1005TEN" - }, - "isExchangeable": { - "type": "boolean", - "description": "Whether the ticket is exchangeable.", - "example": true - }, - "isRefundable": { - "type": "boolean", - "description": "Whether the ticket is refundable.", - "example": true - } - }, - "description": "ConditionSummary." - }, - "Count": { - "required": [ - "numberOfElements" - ], - "type": "object", - "properties": { - "numberOfElements": { - "type": "integer", - "description": "number of elements", - "format": "int32", - "example": 369 - } - }, - "description": "Count" - }, - "DayType": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "dayLength": { - "type": "string", - "description": "Day length. Represented as a string formatted according to ISO-8601", - "example": "PT04H" - }, - "description": { - "type": "array", - "description": "Description of day type", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "durationAfterPropertiesOfDay": { - "type": "string", - "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", - "example": "PT7H" - }, - "durationBeforePropertiesOfDay": { - "type": "string", - "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", - "example": "PT24H" - }, - "earliestTime": { - "type": "string", - "description": "Earliest time.", - "example": "11:11:11" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:DayType:BicycleFlatFare" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name of day type", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "DayType" - }, - "properties": { - "type": "array", - "description": "Properties of day", - "items": { - "$ref": "#/components/schemas/PropertyOfDay" - } - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "timebandRefs": { - "type": "array", - "description": "Time band references.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "The DayType describe during which the assignment applies" - }, - "DistanceMatrixElement": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "nameOfClass", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distance": { - "type": "number", - "description": "Distance.", - "format": "double", - "example": 16.4 - }, - "endFareZoneRef": { - "type": "string", - "description": "End fare zone reference." - }, - "endScheduledStopPointId": { - "type": "string", - "description": "End scheduled stop point netexId." - }, - "endTariffZoneId": { - "type": "string", - "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef.", - "deprecated": true - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the user profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "groupId": { - "type": "integer", - "description": "Group id.", - "format": "int64", - "example": 4 - }, - "groupRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:DistanceMatrixElement:NSR167ToNSR359" - }, - "inverseAllowed": { - "type": "boolean", - "description": "Inverse is allowed.", - "example": true - }, - "isDirect": { - "type": "boolean", - "description": "Is a direct route.", - "example": true - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "name": { - "type": "array", - "description": "DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "DistanceMatrixElement" - }, - "prices": { - "type": "array", - "description": "Fare prices for the user profile.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "relativeRanking": { - "type": "integer", - "description": "Relative ranking.", - "format": "int32", - "example": 2 - }, - "startFareZoneRef": { - "type": "string", - "description": "Start fare zone reference." - }, - "startScheduledStopPointId": { - "type": "string", - "description": "Start scheduled stop point netexId." - }, - "startTariffZoneId": { - "type": "string", - "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef.", - "deprecated": true - }, - "tariffId": { - "type": "integer", - "description": "Tariff id.", - "format": "int64" - }, - "tariffRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "DistanceMatrixElement version.", - "example": "NSB:Version:V1" - } - }, - "description": "A DistanceMatrixElement" - }, - "DistanceMatrixElementInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distance": { - "type": "number", - "description": "Distance.", - "format": "double", - "example": 16.4 - }, - "endFareZoneRef": { - "type": "string", - "description": "End fare zone reference." - }, - "endScheduledStopPointId": { - "type": "string", - "description": "End scheduled stop point netexId." - }, - "endTariffZoneId": { - "type": "string", - "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef", - "deprecated": true - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the user profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "groupRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:DistanceMatrixElement:NSR167ToNSR359" - }, - "inverseAllowed": { - "type": "boolean", - "description": "Inverse is allowed.", - "example": true - }, - "isDirect": { - "type": "boolean", - "description": "Is a direct route.", - "example": true - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "name": { - "type": "array", - "description": "DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices for the user profile.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "relativeRanking": { - "type": "integer", - "description": "Relative ranking.", - "format": "int32", - "example": 2 - }, - "startFareZoneRef": { - "type": "string", - "description": "Start fare zone reference." - }, - "startScheduledStopPointId": { - "type": "string", - "description": "Start scheduled stop point netexId." - }, - "startTariffZoneId": { - "type": "string", - "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef", - "deprecated": true - }, - "tariffRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "DistanceMatrixElement version.", - "example": "NSB:Version:V1" - } - }, - "description": "A DistanceMatrixElement create request " - }, - "DistributionAssignment": { - "required": [ - "allDistributionChannelsRef", - "changed", - "created", - "distributionRights", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "organisationRef", - "paymentMethods", - "salesPackageRef", - "status", - "version" - ], - "type": "object", - "properties": { - "allDistributionChannelsRef": { - "type": "boolean", - "description": "Flag for distribution in all channels." - }, - "allOrganisationRef": { - "type": "boolean", - "description": "Flag for all organisations." - }, - "allowedInChannel": { - "type": "boolean", - "description": "Flag for allowed in channel." - }, - "allowedInCountry": { - "type": "boolean", - "description": "Flag for allowed in country." - }, - "anyCountryRef": { - "type": "boolean", - "description": "Flag for allowed in any country." - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef." - }, - "countryRef": { - "type": "string", - "description": "Country reference." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionChannelRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "distributionChannelType": { - "type": "string", - "description": "Type of distribution channel.", - "enum": [ - "AT_STOP", - "ON_BOARD", - "ONLINE", - "TELEPHONE", - "ELECTRONIC_PASS", - "MOBILE_DEVICE", - "AGENCY", - "TOUR_OPERATOR", - "OTHER" - ] - }, - "distributionRights": { - "type": "string", - "description": "Distribution rights.", - "example": "SELL", - "enum": [ - "NONE", - "SELL", - "REFUND", - "EXCHANGE", - "INFROM", - "PRIVATE", - "OTHER" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "finalCarrier": { - "type": "boolean", - "description": "Flag for final carrier." - }, - "fulfilmentMethodRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfDistributionChannelsRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfSalesPackagesRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:DistributionAssignment:Ordinary" - }, - "initialCarrier": { - "type": "boolean", - "description": "Flag for initial carrier." - }, - "mandatoryProduct": { - "type": "boolean", - "description": "Flag for mandatory product." - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "DistributionAssignment" - }, - "organisationRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "paymentMethods": { - "type": "array", - "description": "Payment methods.", - "items": { - "type": "string" - } - }, - "requiresRegistration": { - "type": "boolean", - "description": "Flag for requires registration." - }, - "responsibilitySetRef": { - "type": "string", - "description": "Responsibility set reference." - }, - "restrictedToChannel": { - "type": "boolean", - "description": "Flag for restricted to channel." - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "serviceAccessRightRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "ticketingServices": { - "type": "array", - "description": "Ticketing services.", - "items": { - "type": "string" - } - }, - "topographicPlaceRef": { - "type": "string", - "description": "Topographical place reference." - }, - "transitCarrier": { - "type": "boolean", - "description": "Flag for transit carrier." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A distributionAssignment" - }, - "DistributionAssignmentInsert": { - "required": [ - "allDistributionChannelsRef", - "distributionRights", - "fareFrameRef", - "id", - "name", - "organisationRef", - "salesPackageRef", - "version" - ], - "type": "object", - "properties": { - "allDistributionChannelsRef": { - "type": "boolean", - "description": "Flag for distribution in all channels." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionChannelRef": { - "type": "string", - "description": "Distribution channel Ref." - }, - "distributionRights": { - "type": "string", - "description": "Distribution rights.", - "example": "SELL", - "enum": [ - "NONE", - "SELL", - "REFUND", - "EXCHANGE", - "INFROM", - "PRIVATE", - "OTHER" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fulfilmentMethodRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfDistributionChannelsRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:DistributionAssignment:Ordinary" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "organisationRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "paymentMethods": { - "type": "array", - "description": "Payment methods.", - "items": { - "type": "string" - } - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "ElementUsages": { - "type": "object", - "properties": { - "elementRefs": { - "type": "array", - "description": "Parameters usages mapped to the requested parameter.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - } - }, - "description": "ParameterUsages" - }, - "EntitlementConstraint": { - "required": [ - "nameOfClass" - ], - "type": "object", - "properties": { - "classOfUseConstraint": { - "type": "string", - "description": "Class of use constraint", - "enum": [ - "ANY", - "SAME", - "SAME_OR_EQUIVALENT", - "DIFFERENT" - ] - }, - "destinationConstraint": { - "type": "string", - "description": "Destination constraint", - "enum": [ - "ANY", - "SAME", - "SAME_AS_ORIGIN", - "SAME_AS_DESTINATION", - "SAME_AS_ORIGIN_OR_DESTINATION", - "ANY_STOP_ON_ROUTE", - "ANY_STOP_IN_ZONE", - "DIFFERENT" - ] - }, - "directionConstraint": { - "type": "string", - "description": "Direction constraint", - "enum": [ - "ANY", - "SAME", - "OPPOSITE_DIRECTION", - "DIFFERENT" - ] - }, - "fareScheduledStopPoints": { - "type": "array", - "description": "Fare scheduled stop points which entitlement applies", - "items": { - "$ref": "#/components/schemas/FareScheduledStopPoint" - } - }, - "journeyConstraint": { - "type": "string", - "description": "Journey constraint", - "enum": [ - "ANY", - "SAME", - "SIMILAR", - "DIFFERENT" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "EntitlementConstraint" - }, - "operatorConstraint": { - "type": "string", - "description": "Operator constraint", - "enum": [ - "ANY", - "SAME", - "PARTICIPATING", - "DIFFERENT" - ] - }, - "originConstraint": { - "type": "string", - "description": "Origin constraint", - "enum": [ - "ANY", - "SAME", - "SAME_AS_ORIGIN", - "SAME_AS_DESTINATION", - "SAME_AS_ORIGIN_OR_DESTINATION", - "ANY_STOP_ON_ROUTE", - "ANY_STOP_IN_ZONE", - "DIFFERENT" - ] - }, - "periodConstraint": { - "type": "string", - "description": "Period constraint", - "enum": [ - "ANY", - "SAME_PERIOD", - "WITHIN_SAME_PERIOD", - "SAME_DAY", - "SAME_DAY_OF_RETURN", - "SAME_FARE_DAY", - "NEXT_DAY", - "EQUIVALENT_DURATION", - "DIFFERENT" - ] - }, - "routeConstraint": { - "type": "string", - "description": "Route constraint", - "enum": [ - "ANY", - "SAME", - "OPPOSITE_DIRECTION", - "DIFFERENT" - ] - }, - "specificProfiles": { - "type": "array", - "description": "Specific user profiles which entitlement applies", - "items": { - "type": "string" - } - }, - "tariffZoneConstraint": { - "type": "string", - "description": "Tariff zone constraint", - "enum": [ - "ANY", - "SAME", - "SAME_AS_ORIGIN", - "SAME_AS_DESTINATION", - "SAME_AS_ORIGIN_OR_DESTINATION", - "WITHIN", - "CONTAINING", - "EQUIVALENT", - "DIFFERENT" - ] - }, - "typeOfProductCategoryConstraint": { - "type": "string", - "description": "Type of product category constraint", - "enum": [ - "ANY", - "SAME", - "SAME_OR_EQUIVALENT", - "DIFFERENT" - ] - }, - "typeOfTravelDocumentConstraint": { - "type": "string", - "description": "Type of travel document constraint", - "enum": [ - "ANY", - "SAME", - "SAME_MEDIA", - "SAME_SMART_CARD", - "SAME_MOBILE_APP", - "DIFFERENT" - ] - }, - "userConstraint": { - "type": "string", - "description": "User constraint", - "enum": [ - "ANYONE", - "SAME_PERSON", - "DIFFERENT_PERSON", - "SPECIFIC" - ] - } - }, - "description": "Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.", - "readOnly": true - }, - "EntitlementGiven": { - "required": [ - "changed", - "created", - "description", - "entitlementType", - "fareFrameRef", - "id", - "modification", - "name", - "nameOfClass", - "prices", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "entitlementConstraint": { - "$ref": "#/components/schemas/EntitlementConstraint" - }, - "entitlementType": { - "type": "string", - "description": "Entitlement type", - "enum": [ - "USE", - "PURCHASE", - "PURCHASE_AT_DISCOUNT", - "NONE" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:EntitlementGiven:TrondelagCustomerCard" - }, - "minimumQualificationPeriod": { - "type": "string", - "description": "Minimum qualification period", - "example": "01:59:59.999999999" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the entitlement given represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "EntitlementGiven" - }, - "prices": { - "type": "array", - "description": "Prices for the entitlement given.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "serviceAccessRightRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "EntitlementProduct": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "validityConditions" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "type": "string", - "description": "Id.", - "example": "RUT:EntitlementProduct:PersonalTicket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "EntitlementProduct" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "An ENTITLEMENT PRODUCT response." - }, - "EntitlementRequired": { - "required": [ - "changed", - "created", - "description", - "fareFrameRef", - "id", - "modification", - "name", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "entitlementConstraint": { - "$ref": "#/components/schemas/EntitlementConstraint" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "ENT:EntitlementRequired:SingleTicket" - }, - "minimumQualificationPeriod": { - "type": "string", - "description": "Minimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the entitlement required represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "EntitlementRequired" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Fare prices for the entitlement required.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "serviceAccessRightNetexId": { - "type": "string", - "description": "Reference to the serviceAccessRight required.", - "example": "ENT:PreassignedFareProduct:SingleTicket" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter.", - "example": "ENT:TypeOfUsageParameter:OpenSeating" - }, - "validityConditions": { - "type": "array", - "description": "Pricing rule reference.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "ENT:Version:ER-SingleTicket-1" - } - }, - "description": "Entitlement Required." - }, - "Exchanging": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "allowed": { - "type": "string", - "description": "Allowed.", - "example": "FULL", - "enum": [ - "NONE", - "PARTIAL", - "FULL" - ] - }, - "canChangeClass": { - "type": "boolean", - "description": "Whether user can change class." - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "exchangeableFromAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded from any point after purchase." - }, - "exchangeableFromDuration": { - "type": "string", - "description": "Duration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.", - "example": "PT24H" - }, - "exchangeableTo": { - "type": "string", - "description": "Type of exchange allowed.", - "enum": [ - "ANY_PRODUCT", - "SAME_PRODUCT_SAME_DAY", - "SAME_PRODUCT_ANY_DAY", - "UPGRADE_TO_STANDARD_FARE", - "SPECIFIED_PRODUCTS" - ] - }, - "exchangeableUntilAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded until any point after purchase." - }, - "exchangeableUntilDuration": { - "type": "string", - "description": "Duration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.", - "example": "PT24H" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "hasFee": { - "type": "boolean", - "description": "Has fee." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Exchanging:MiniFlex" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Exchanging" - }, - "numberOfExchangesAllowed": { - "type": "integer", - "description": "Number of times a ticket may be exchanged.", - "format": "int32" - }, - "onlyAtCertainDistributionPoints": { - "type": "boolean", - "description": "Whether distribution is restricted to certain points." - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the exchanging rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "refundBasis": { - "type": "string", - "description": "Basis on which refund is made. See allowed values below.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "resellWhen": { - "type": "string", - "description": "Event marking when the exchangeable status of the ticket changes.", - "example": "NEVER", - "enum": [ - "NEVER", - "BEFORE_START_OF_VALIDITY_PERIOD", - "AFTER_START_OF_VALIDITY_PERIOD", - "AFTER_END_OF_VALIDITY_PERIOD", - "BEFORE_FIRST_USE", - "AFTER_FIRST_USE", - "BEFORE_VALIDATION", - "AFTER_VALIDATION", - "AFTER_PURCHASE" - ] - }, - "specifiedProducts": { - "type": "array", - "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with \u0027exchangeableTo.SPECIFIED_PRODUCTS\u0027", - "items": { - "type": "string" - } - }, - "status": { - "type": "string", - "description": "Exchanging status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "toFareClass": { - "type": "string", - "description": "Fare class to which can be exchanged.", - "enum": [ - "FIRST_CLASS", - "SECOND_CLASS", - "THIRD_CLASS", - "ECONOMY_CLASS", - "BUSINESS_CLASS", - "TURISTA", - "PREFERENTE", - "STANDARD_CLASS", - "PREMIUM_CLASS", - "ANY", - "UNKNOWN" - ] - }, - "unusedTicketsOnly": { - "type": "boolean", - "description": "Unused tickets only." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Exchanging version.", - "example": "NSB:Version:V1" - } - }, - "description": "Exchanging" - }, - "ExchangingAlternatives": { - "required": [ - "exchangingOptions", - "ref" - ], - "type": "object", - "properties": { - "exchangingOptions": { - "type": "array", - "description": "Exchanging alternatives for this element.", - "items": { - "$ref": "#/components/schemas/Exchanging" - } - }, - "ref": { - "$ref": "#/components/schemas/IdAndVersion" - } - }, - "description": "Exchanging alternatives for an element." - }, - "ExchangingInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "allowed": { - "type": "string", - "description": "Allowed.", - "example": "FULL", - "enum": [ - "NONE", - "PARTIAL", - "FULL" - ] - }, - "canChangeClass": { - "type": "boolean", - "description": "Whether user can change class." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "exchangeableFromAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded from any point after purchase." - }, - "exchangeableFromDuration": { - "type": "string", - "description": "Exchangeable from duration.", - "example": "PT24H" - }, - "exchangeableTo": { - "type": "string", - "description": "Type of exchange allowed.", - "enum": [ - "ANY_PRODUCT", - "SAME_PRODUCT_SAME_DAY", - "SAME_PRODUCT_ANY_DAY", - "UPGRADE_TO_STANDARD_FARE", - "SPECIFIED_PRODUCTS" - ] - }, - "exchangeableUntilAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded until any point after purchase." - }, - "exchangeableUntilDuration": { - "type": "string", - "description": "Exchangeable until duration.", - "example": "PT24H" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "hasFee": { - "type": "boolean", - "description": "Has fee." - }, - "id": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Exchanging:MiniFlex" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "numberOfExchangesAllowed": { - "type": "integer", - "description": "Number of times a ticket may be exchanged.", - "format": "int32" - }, - "onlyAtCertainDistributionPoints": { - "type": "boolean", - "description": "Whether distribution is restricted to certain points." - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "refundBasis": { - "type": "string", - "description": "Basis on which refund is made. See allowed values below.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "resellWhen": { - "type": "string", - "description": "Event marking when the exchangeable status of the ticket changes.", - "example": "NEVER", - "enum": [ - "NEVER", - "BEFORE_START_OF_VALIDITY_PERIOD", - "AFTER_START_OF_VALIDITY_PERIOD", - "AFTER_END_OF_VALIDITY_PERIOD", - "BEFORE_FIRST_USE", - "AFTER_FIRST_USE", - "BEFORE_VALIDATION", - "AFTER_VALIDATION,AFTER_PURCHASE" - ] - }, - "specifiedProducts": { - "type": "string", - "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with \u0027exchangeableTo.SPECIFIED_PRODUCTS\u0027." - }, - "toFareClass": { - "type": "string", - "description": "Fare class to which can be exchanged.", - "enum": [ - "FIRST_CLASS", - "SECOND_CLASS", - "THIRD_CLASS", - "ECONOMY_CLASS", - "BUSINESS_CLASS", - "TURISTA", - "PREFERENTE", - "STANDARD_CLASS", - "PREMIUM_CLASS", - "ANY", - "UNKNOWN" - ] - }, - "unusedTicketsOnly": { - "type": "boolean", - "description": "Unused tickets only." - }, - "version": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UsageValidityPeriod version.", - "example": "NSB:Version:V1" - } - } - }, - "FareDayType": { - "required": [ - "changed", - "created", - "description", - "id", - "modification", - "name", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "dayLength": { - "type": "string", - "description": "Day length. Represented as a string formatted according to ISO-8601", - "example": "PT04H" - }, - "description": { - "type": "array", - "description": "Description of fare day type", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "durationAfterPropertiesOfDay": { - "type": "string", - "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", - "example": "PT7H" - }, - "durationBeforePropertiesOfDay": { - "type": "string", - "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", - "example": "PT24H" - }, - "earliestTime": { - "type": "string", - "description": "Earliest time.", - "example": "11:11:11" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareDayType:2HoursValidPlus1" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name of fare day type", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "FareDayType" - }, - "properties": { - "type": "array", - "description": "Properties of day", - "items": { - "$ref": "#/components/schemas/PropertyOfDay" - } - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "timebandRefs": { - "type": "array", - "description": "Time band references.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "The FareDayType describe during which the assignment applies" - }, - "FareFrame": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareProducts": { - "type": "array", - "description": "FareProducts.", - "items": { - "$ref": "#/components/schemas/FareProduct" - } - }, - "fareStructureElements": { - "type": "array", - "description": "FareStructureElements.", - "items": { - "$ref": "#/components/schemas/FareStructureElement" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareFrame:Child" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "FareFrame Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "FareFrame" - }, - "salesPackages": { - "type": "array", - "description": "SalesPackages.", - "items": { - "$ref": "#/components/schemas/SalesPackage" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "transportOrganisationNameOfClass": { - "type": "string", - "description": "Transport organisation nameOfClass.", - "example": "16" - }, - "transportOrganisationNetexId": { - "type": "string", - "description": "Transport organisation netexId." - }, - "transportOrganisationRef": { - "type": "string", - "description": "Transport organisation ref.", - "example": "CHILD" - }, - "transportOrganisationVersion": { - "type": "string", - "description": "Transport organisation version.", - "example": "4" - }, - "typeOfFareFrameNetexId": { - "type": "string", - "description": "Type of fareFrame netexId." - }, - "typeOfFareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "typeOfFareFrameVersion": { - "type": "string", - "description": "Type of fareFrame version." - }, - "validableElements": { - "type": "array", - "description": "ValidableElements.", - "items": { - "$ref": "#/components/schemas/ValidableElement" - } - }, - "validityConditions": { - "type": "array", - "description": "Validity condition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "vehicleMode": { - "type": "string", - "description": "Vehicle mode.", - "enum": [ - "AIR", - "BUS", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TRAM", - "UNKNOWN" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "FareFrame version.", - "example": "NSB:Version:V1" - } - }, - "description": "A FareFrame" - }, - "FarePointInPattern": { - "required": [ - "id", - "journeyPatternRef", - "modification", - "orderOfElement", - "pointRef", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:FarePointInPattern:TrondheimOslo" - }, - "journeyPatternRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "FarePointInPattern" - }, - "orderOfElement": { - "type": "integer", - "description": "Order of element", - "format": "int32" - }, - "pointRef": { - "type": "string", - "description": "Point Ref" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "Validity Conditions.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "type": "string", - "description": "Version, will be a versioned child of journey pattern", - "readOnly": true, - "example": "NSB:Version:V1" - } - }, - "description": "A Fare Point In Pattern" - }, - "FarePrice": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "amount": { - "type": "string", - "description": "Amount", - "example": "164.0" - }, - "canBeCumulative": { - "type": "boolean", - "description": "canBeCumulative.", - "example": true - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "currency": { - "type": "string", - "description": "Currency.", - "example": "NOK" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "discountPercentageUsed": { - "maximum": 100, - "minimum": -100, - "type": "integer", - "description": "discountPercentageUsed.", - "format": "int32", - "example": 5 - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "type": "string", - "description": "Id.", - "example": "NSB:FarePrice:1005TEN" - }, - "isAllowed": { - "type": "boolean", - "description": "isAllowed.", - "example": true - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "FarePrice" - }, - "ranking": { - "type": "integer", - "description": "Ranking.", - "format": "int32", - "example": 1 - }, - "rounding": { - "$ref": "#/components/schemas/Rounding" - }, - "roundingRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "vatRegisterGroup": { - "type": "string", - "description": "vatRegisterGroup.", - "example": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "type": "string", - "description": "Version.", - "readOnly": true, - "example": "NSB:Version:V1" - } - }, - "description": "A description of the price and factor for a set fare" - }, - "FarePriceInsert": { - "required": [ - "fareFrameRef", - "id", - "name" - ], - "type": "object", - "properties": { - "amount": { - "type": "string", - "description": "Amount.", - "example": "164.0" - }, - "canBeCumulative": { - "type": "boolean", - "description": "canBeCumulative.", - "example": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "currency": { - "type": "string", - "description": "Currency.", - "example": "NOK" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "discountPercentageUsed": { - "type": "integer", - "description": "discountPercentageUsed.", - "format": "int32", - "example": 5 - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FarePrice:1005TEN" - }, - "isAllowed": { - "type": "boolean", - "description": "isAllowed.", - "example": true - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "ranking": { - "type": "integer", - "description": "Ranking.", - "format": "int32", - "example": 1 - }, - "rounding": { - "$ref": "#/components/schemas/RoundingInsert" - }, - "roundingRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "vatRegisterGroup": { - "type": "string", - "description": "vatRegisterGroup.", - "example": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "type": "string" - } - } - }, - "FarePriceUpdate": { - "type": "object", - "properties": { - "amount": { - "type": "number", - "description": "Amount in the currency selected at create operation", - "format": "double", - "example": 16.5 - }, - "discountPercentageUsed": { - "type": "integer", - "description": "Discount in percentageUsed", - "format": "int32", - "example": 40 - } - } - }, - "FareProduct": { - "required": [ - "accessRightParameterAssignments", - "accessRightsInProduct", - "changed", - "chargingMoment", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "validityConditions" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active for this SP.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "SalesPackage changed datetime." - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "SalesPackage create datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:PreassignedFareProduct:RuterSingleTicket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "PreassignedFareProduct" - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the fareProduct" - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT" - }, - "FareQuotaFactor": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareStructureElementRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:FareQuotaFactor:SomeFareQuota4" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "FareQuotaFactor" - }, - "numberOfUnits": { - "type": "integer", - "description": "The number of units.", - "format": "int32" - }, - "prices": { - "type": "array", - "description": "Fare prices for the fare quota factor.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "Gives a sequence of conditions for validity.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "value": { - "type": "string", - "description": "The value of fare quota factor." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "FareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored", - "example": "ENT:Version:SomeVersion4" - } - }, - "description": "A FareQuotaFactor" - }, - "FareScheduledStopPoint": { - "type": "object", - "properties": { - "stopPlaceNetexId": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Stop place Netex Id" - }, - "stopPointNetexId": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Stop point Netex Id" - } - }, - "description": "FareScheduledStopPoint, stopPlace and stopPoint Netex Ids should point to same location" - }, - "FareSection": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fromFarePointRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:FareSection:TrondheimOslo" - }, - "journeyPatternRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "FareSection" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "toFarePointRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A Fare section." - }, - "FareStructureElement": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "geographicalIntervalRefs", - "geographicalStructureFactorRefs", - "id", - "modification", - "nameOfClass", - "parameterAssignments", - "pointToPointFareRefs", - "qualityStructureFactorRefs", - "status", - "validityConditions" - ], - "type": "object", - "properties": { - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "fare table reference", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "geographicalIntervalRefs": { - "type": "array", - "description": "geographical interval sequence", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "geographicalStructureFactorRefs": { - "type": "array", - "description": "geographical structure factor refs", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareStructureElement:TENInterval" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "FareStructureElement" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile", - "readOnly": true - }, - "parameterAssignments": { - "type": "array", - "description": "Access Right Parameter assignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "pointToPointFareRefs": { - "type": "array", - "description": "Field is deprecated. Distance matrix elements should be connected by a \u0027geographical structure factor\u0027", - "deprecated": true, - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "qualityStructureFactorRefs": { - "type": "array", - "description": "quality structure factor refs", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "tariffBasis": { - "type": "string", - "description": "Tariff basis.", - "example": "DISTANCE", - "enum": [ - "FLAT", - "DISTANCE", - "UNIT_SECTION", - "ZONE", - "ZONE_TO_ZONE", - "POINT_TO_POINT", - "ROUTE", - "TOUR", - "GROUP", - "DISCOUNT", - "PERIOD", - "FREE", - "OTHER" - ] - }, - "validityConditions": { - "type": "array", - "description": "ValidityConditions sequence.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A element describing the response structure of the fare" - }, - "FareStructureElementInSequence": { - "required": [ - "accessNumber", - "changed", - "created", - "fareFrameRef", - "fareStructureElementId", - "fareStructureElementRef", - "id", - "nameOfClass", - "version" - ], - "type": "object", - "properties": { - "accessNumber": { - "type": "integer", - "description": "The actual ordering in the sequence", - "format": "int32" - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementId": { - "type": "string", - "description": "Fare structure element ref" - }, - "fareStructureElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareStructureElementInSequence:MiniPriceTENInterval" - }, - "isFirstInSequence": { - "type": "boolean", - "description": "Gives information if this sequence first or not" - }, - "isLastInSequence": { - "type": "boolean", - "description": "Gives information if this sequence last or not" - }, - "limitedAccessNumber": { - "type": "integer", - "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", - "format": "int32" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "FareStructureElementInSequence" - }, - "orderOfElement": { - "type": "integer", - "description": "Access quality structure factor refs", - "format": "int32" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Fare structure element in sequence version.", - "example": "NSB:Version:V1" - } - }, - "description": "A description of a fare structure element in sequence" - }, - "FareStructureElementInSequenceInsert": { - "required": [ - "fareFrameRef", - "fareStructureElementId", - "id", - "version" - ], - "type": "object", - "properties": { - "accessNumber": { - "type": "integer", - "description": "The actual access number", - "format": "int32" - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementId": { - "type": "string", - "description": "Fare structure element id", - "example": "NSB:FareStructureElement:TENInterval" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareStructureElementInSequence:MiniPriceTENInterval" - }, - "isFirstInSequence": { - "type": "boolean", - "description": "Whether element is first in sequence" - }, - "isLastInSequence": { - "type": "boolean", - "description": "Whether element is last in sequence" - }, - "limitedAccessNumber": { - "type": "integer", - "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", - "format": "int32" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "orderOfElement": { - "type": "integer", - "description": "Access quality structure factor refs", - "format": "int32" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "FareStructureElementInsert": { - "required": [ - "fareFrameRef", - "fareTableRefs", - "geographicalIntervalRefs", - "id", - "parameterAssignmentRefs" - ], - "type": "object", - "properties": { - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "fare table reference", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "geographicalIntervalRefs": { - "type": "array", - "description": "geographical interval sequence", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "geographicalStructureFactorId": { - "type": "string", - "description": "Geographical structure factor id", - "example": "NSB:GeographicalStructureFactor:TENPrices" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareStructureElement:TENInterval" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "parameterAssignmentRefs": { - "type": "array", - "description": "Access Right Parameter assignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "pointToPointFareRefs": { - "type": "array", - "description": "Field is deprecated. Use \u0027geographical structure factor\u0027 instead to connect \u0027distance matrix elements\u0027 to \u0027fare structure element\u0027", - "deprecated": true, - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "tariffBasis": { - "type": "string", - "description": "Tariff basis.", - "example": "DISTANCE", - "enum": [ - "FLAT", - "DISTANCE", - "UNIT_SECTION", - "ZONE", - "ZONE_TO_ZONE", - "POINT_TO_POINT", - "ROUTE", - "TOUR", - "GROUP", - "DISCOUNT", - "PERIOD", - "FREE", - "OTHER" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "FareStructureElementPageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "Fare structure elements for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/FareStructureElement" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Number of the requested page. In case state is lost", - "format": "int32", - "example": 369 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "FareTablePageWrapper" - }, - "FareTable": { - "required": [ - "cells", - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "prices", - "status", - "version" - ], - "type": "object", - "properties": { - "cells": { - "type": "array", - "description": "Cell", - "items": { - "$ref": "#/components/schemas/Cell" - } - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "endDate": { - "type": "string", - "description": "EndDate.", - "format": "date", - "example": "2017-11-11" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareTable:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "FareTable" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the fare table", - "readOnly": true - }, - "prices": { - "type": "array", - "description": "FarePrice.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "startDate": { - "type": "string", - "description": "StartDate.", - "format": "date", - "example": "2017-11-11" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A FareTable" - }, - "FareTableInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "cells": { - "type": "array", - "description": "Cell", - "items": { - "$ref": "#/components/schemas/CellInsert" - } - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "endDate": { - "type": "string", - "description": "EndDate.", - "format": "date" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FareTable:Ordinary" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "FarePrice.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "startDate": { - "type": "string", - "description": "StartDate.", - "format": "date" - }, - "tariffRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "FareTablePageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "Fare Tables for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/FareTable" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Number of the requested page. In case state is lost", - "format": "int32", - "example": 369 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "FareTablePageWrapper" - }, - "FareTableRef": { - "type": "object", - "properties": { - "nameOfRefClass": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "FrequencyOfUse": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Frequency of use changed datetime.", - "format": "date-time" - }, - "created": { - "type": "string", - "description": "Frequency of use created datetime.", - "format": "date-time" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "frequencyOfUseType": { - "type": "string", - "description": "Frequency of use type.", - "example": "SINGLE", - "enum": [ - "NONE", - "SINGLE", - "LIMITED", - "UNLIMITED", - "TWICE_A_DAY" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FrequencyOfUse:Single" - }, - "maximalFrequency": { - "type": "integer", - "description": "Maximal frequency given for this frequency of use.", - "format": "int32" - }, - "minimalFrequency": { - "type": "integer", - "description": "Minimal frequency given for this frequency of use.", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "FrequencyOfUse" - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the refunding rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Frequency of use version.", - "example": "NSB:Version:V1" - } - }, - "description": "Frequency of use" - }, - "FrequencyOfUseInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "frequencyOfUseType": { - "type": "string", - "description": "Frequency of use type.", - "example": "SINGLE", - "enum": [ - "NONE", - "SINGLE", - "LIMITED", - "UNLIMITED", - "TWICE_A_DAY" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FrequencyOfUse:Single" - }, - "maximalFrequency": { - "type": "integer", - "description": "Maximal frequency given for this frequency of use.", - "format": "int32" - }, - "minimalFrequency": { - "type": "integer", - "description": "Minimal frequency given for this frequency of use.", - "format": "int32" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the frequency of use.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Frequency of use version.", - "example": "NSB:Version:V1" - } - } - }, - "FulfilmentMethod": { - "required": [ - "changed", - "created", - "description", - "fareFrameRef", - "id", - "name", - "prices", - "status", - "typesOfTravelDocument", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fulfilmentMethodType": { - "type": "string", - "description": "Type of fulfilment method.", - "enum": [ - "TICKET_OFFICE", - "TICKET_MACHINE", - "CONDUCTOR", - "AGENT", - "POST", - "SELFPRINT", - "SMS", - "TOP_UP_DEVICE", - "VALIDATOR", - "MOBILE_APP", - "CUSTOMER_ACCOUNT", - "OTHER" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:FulfilmentMethod:TicketOffice" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the fulfilment method represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "FulfilmentMethod" - }, - "prices": { - "type": "array", - "description": "Prices for the fulfilment method.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "requiresBookingReference": { - "type": "boolean", - "description": "Whether collecting ticket requires booking reference." - }, - "requiresCard": { - "type": "boolean", - "description": "Whether collecting ticket requires credit card used to purchase." - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typesOfTravelDocument": { - "type": "array", - "description": "Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "GeneralGroupOfEntities": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "members", - "modification", - "nameOfClass", - "nameOfMemberClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:GeneralGroupOfEntities:SomeId" - }, - "members": { - "type": "array", - "description": "Member refs.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "GeneralGroupOfEntities" - }, - "nameOfMemberClass": { - "type": "string", - "description": "Name of member class" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the general group of entities.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "GeneralGroupOfEntities version.", - "example": "ENT:Version:SomeVersion" - } - }, - "description": "General Group of Entities." - }, - "GenericParameterAssignment": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "canIgnoreInOffering": { - "type": "boolean", - "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", - "example": true - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "chargingBasisType": { - "type": "string", - "description": "ChargingBasisType.", - "example": "FREE", - "enum": [ - "FREE", - "DISCOUNTED", - "NORMAL", - "ANY" - ] - }, - "comparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether a gpa belongs to A or E gpa implementation.", - "example": "A" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef.", - "example": "NSB:Version:V1" - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "example": "NSB:Version:V1" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GenericParameterAssignment:AllowedOperators" - }, - "includes": { - "type": "array", - "description": "Includes genericParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "includesGroupingType": { - "type": "string", - "description": "Includes grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "limitationGroupingType": { - "type": "string", - "description": "Limitation grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "limitations": { - "type": "array", - "description": "Limitations as UsageParameters.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "example": "GenericParameterAssignment" - }, - "parentParameterAssignmentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "requiredElements": { - "type": "array", - "description": "Required elements.", - "items": { - "type": "string" - } - }, - "requiredInContext": { - "type": "string", - "description": "Required in context.", - "enum": [ - "OFFERING", - "BOOKING", - "RESERVATION", - "SALE", - "FULFILMENT", - "ACTIVATION", - "CONSUMPTION", - "REVALIDATION" - ] - }, - "requiredType": { - "type": "string", - "description": "Required type.", - "example": "SERVICE_JOURNEY_REF", - "enum": [ - "SERVICE_JOURNEY_REF", - "TARIFF_ZONE_REF", - "PASSENGER_SEAT_REF", - "USER_PROFILE_REF", - "USAGE_VALIDITY_PERIOD_REF", - "DATED_SERVICE_JOURNEY_REF", - "DYNAMIC_DISTANCE_MATRIX_ELEMENT", - "USAGE_VALIDITY_PERIOD", - "DISTANCE_MATRIX_ELEMENT_REF", - "SCHEDULED_STOP_POINT_REF", - "GROUP_TICKET_REF", - "GROUP_TICKET", - "GROUP_OF_TARIFF_ZONES_REF", - "FARE_ZONE_REF" - ] - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "temporalValidityParameters": { - "type": "array", - "description": "Temporal validity parameter.", - "items": { - "$ref": "#/components/schemas/TemporalValidityParameter" - } - }, - "typeOfAccessRightAssignment": { - "$ref": "#/components/schemas/TypeOfAccessRightAssignment" - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityParameterAssignmentType": { - "type": "string", - "description": "Validity parameter assignment type.", - "example": "EQ", - "enum": [ - "EQ", - "NE", - "GT", - "LT", - "GE", - "LE" - ] - }, - "validityParameterGroupingType": { - "type": "string", - "description": "Validity parameter grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "validityParameterSetSelectionType": { - "type": "string", - "description": "Validity parameter set operator.", - "enum": [ - "ONE_OF_ANY_ONE_SET", - "ONE_OF_EACH_SET", - "SOME_OF_ANY_SET", - "ALL_OF_ONE_SET", - "ALL_OF_ALL_SETS" - ] - }, - "validityParameters": { - "type": "array", - "description": "Validity parameters as scoping validity parameters", - "items": { - "$ref": "#/components/schemas/ScopingValidityParameter" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V2" - } - }, - "description": "A GenericParameterAssignment" - }, - "GenericParameterAssignmentInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "canIgnoreInOffering": { - "type": "boolean", - "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", - "example": true - }, - "chargingBasisType": { - "type": "string", - "description": "ChargingBasisType.", - "example": "FREE", - "enum": [ - "FREE", - "DISCOUNTED", - "NORMAL", - "ANY" - ] - }, - "comparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether a gpa belongs to A or E gpa implementation.", - "example": "A" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef.", - "example": "NSB:Version:V1" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "example": "NSB:Version:V1" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GenericParameterAssignment:AllowedOperators" - }, - "includes": { - "type": "array", - "description": "Includes genericParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignmentInsert" - } - }, - "includesGroupingType": { - "type": "string", - "description": "Includes grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "limitationGroupingType": { - "type": "string", - "description": "Limitation grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "limitations": { - "type": "array", - "description": "Limitations as UsageParameters.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "parentParameterAssignmentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "requiredElements": { - "type": "string", - "description": "Required elements.", - "example": "START_DATE", - "enum": [ - "START_DATE", - "START_TIME", - "STANDARD_DURATION", - "START_STOP_POINT_REF", - "END_STOP_POINT_REF", - "START_TARIFF_ZONE_REF", - "END_TARIFF_ZONE_REF" - ] - }, - "requiredInContext": { - "type": "string", - "description": "Required in context.", - "enum": [ - "OFFERING", - "BOOKING", - "RESERVATION", - "SALE", - "FULFILMENT", - "ACTIVATION", - "CONSUMPTION", - "REVALIDATION" - ] - }, - "requiredType": { - "type": "string", - "description": "Required type.", - "example": "SERVICE_JOURNEY_REF", - "enum": [ - "SERVICE_JOURNEY_REF", - "TARIFF_ZONE_REF", - "PASSENGER_SEAT_REF", - "USER_PROFILE_REF", - "USAGE_VALIDITY_PERIOD_REF", - "DATED_SERVICE_JOURNEY_REF", - "DYNAMIC_DISTANCE_MATRIX_ELEMENT", - "USAGE_VALIDITY_PERIOD", - "DISTANCE_MATRIX_ELEMENT_REF", - "SCHEDULED_STOP_POINT_REF", - "GROUP_TICKET_REF", - "GROUP_TICKET", - "GROUP_OF_TARIFF_ZONES_REF", - "FARE_ZONE_REF" - ] - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "temporalValidityParameters": { - "type": "array", - "description": "Temporal Validity parameter.", - "items": { - "$ref": "#/components/schemas/TemporalValidityParameterInsert" - } - }, - "typeOfAccessRightAssignment": { - "$ref": "#/components/schemas/TypeOfAccessRightAssignment" - }, - "validableElementRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityParameterAssignmentType": { - "type": "string", - "description": "Validity parameter assignment type.", - "example": "EQ", - "enum": [ - "EQ", - "NE", - "GT", - "LT", - "GE", - "LE" - ] - }, - "validityParameterGroupingType": { - "type": "string", - "description": "Validity parameter grouping type.", - "example": "AND", - "enum": [ - "AND", - "OR", - "XOR", - "NOT" - ] - }, - "validityParameterSetSelectionType": { - "type": "string", - "description": "Validity parameter set operator.", - "enum": [ - "ONE_OF_ANY_ONE_SET", - "ONE_OF_EACH_SET", - "SOME_OF_ANY_SET", - "ALL_OF_ONE_SET", - "ALL_OF_ALL_SETS" - ] - }, - "validityParameters": { - "type": "array", - "description": "Validity parameters as scoping validity parameters", - "items": { - "$ref": "#/components/schemas/ScopingValidityParameterInsert" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V2" - } - } - }, - "GeographicalInterval": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "endGeographicalValue": { - "type": "integer", - "description": "endGeographicalValue.", - "format": "int64" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "Reference to fare table.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GeographicalInterval:1364TEN" - }, - "intervalType": { - "type": "string", - "description": "intervalType.", - "enum": [ - "STOP", - "TARIFF_ZONE", - "DISTANCE", - "COUPON", - "OTHER" - ] - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "GeographicalInterval" - }, - "numberOfUnits": { - "type": "number", - "description": "numberOfUnits.", - "format": "double" - }, - "prices": { - "type": "array", - "description": "Prices for the fare.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "startGeographicalValue": { - "type": "integer", - "description": "startGeographicalValue.", - "format": "int64" - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "validityConditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "GeographicalInterval" - }, - "GeographicalIntervalInsert": { - "required": [ - "fareFrameRef", - "fareTableRefs", - "id", - "prices" - ], - "type": "object", - "properties": { - "endGeographicalValue": { - "type": "integer", - "description": "EndGeographicalValue.", - "format": "int64" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "Reference to fare table.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GeographicalInterval:1364TEN" - }, - "intervalType": { - "type": "string", - "description": "IntervalType.", - "enum": [ - "STOP", - "TARIFF_ZONE", - "DISTANCE", - "COUPON", - "OTHER" - ] - }, - "numberOfUnits": { - "type": "number", - "description": "NumberOfUnits.", - "format": "double" - }, - "prices": { - "type": "array", - "description": "Prices for the fare.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "startGeographicalValue": { - "type": "integer", - "description": "StartGeographicalValue.", - "format": "int64" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "GeographicalStructureFactor": { - "required": [ - "changed", - "created", - "description", - "distanceMatrixElements", - "fareFrameRef", - "geographicalIntervals", - "id", - "modification", - "name", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distanceMatrixElements": { - "type": "array", - "description": "Distance matrix elements", - "items": { - "$ref": "#/components/schemas/DistanceMatrixElement" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "geographicalIntervals": { - "type": "array", - "description": "Geographical intervals", - "items": { - "$ref": "#/components/schemas/GeographicalInterval" - } - }, - "geographicalUnitRef": { - "type": "string", - "description": "Geographical unit ref" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:GeographicalStructureFactor:50TEN" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the geographical structure factor represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "GeographicalStructureFactor" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "GroupOfDistanceMatrixElements": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "membersId", - "nameOfClass", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameId": { - "type": "integer", - "description": "Fare frame id.", - "format": "int64" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GroupOfDistanceMatrixElements:TENDistances" - }, - "membersId": { - "type": "string", - "description": "DistanceMatrixElements within the group." - }, - "name": { - "type": "array", - "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "GroupOfDistanceMatrixElements" - }, - "tariffId": { - "type": "integer", - "description": "Tariff id.", - "format": "int64" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "GroupOfDistanceMatrixElements version.", - "example": "NSB:Version:V1" - } - }, - "description": "A GroupfOfDistanceMatrixElemenets" - }, - "GroupOfDistanceMatrixElementsInsert": { - "required": [ - "fareFrameRef", - "id", - "members", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameId": { - "type": "integer", - "description": "Fare frame id.", - "format": "int64" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GroupOfDistanceMatrixElements:TENDistances" - }, - "members": { - "type": "array", - "description": "DistanceMatrixElements within the group.", - "items": { - "type": "string" - } - }, - "name": { - "type": "array", - "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "tariffId": { - "type": "integer", - "description": "Tariff id.", - "format": "int64" - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "GroupOfDistanceMatrixElements version.", - "example": "NSB:Version:V1" - } - }, - "description": "A GroupDistanceMatrixElement create request" - }, - "GroupOfTimeBands": { - "required": [ - "changed", - "created", - "id", - "members", - "modification", - "nameOfClass", - "status", - "validityConditions" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id." - }, - "members": { - "type": "array", - "description": "Members.", - "items": { - "$ref": "#/components/schemas/Timeband" - } - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "FareStructureElement" - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "ValidityConditions sequence.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A GroupOfTimeband describe during which the assignments applies" - }, - "GroupTicket": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "companionProfiles": { - "type": "array", - "description": "Companion Profiles in Group Ticket", - "items": { - "$ref": "#/components/schemas/CompanionProfile" - } - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the group ticket.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "groupDiscountBasis": { - "type": "string", - "description": "groupDiscountBasis", - "enum": [ - "FREE", - "DISCOUNT_FOR_ALL", - "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", - "STEP_DISCOUNT", - "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GroupTicket:FamilyDiscount" - }, - "jointCheckIn": { - "type": "string", - "description": "jointCheckIn", - "enum": [ - "NONE", - "ALLOWED", - "REQUIRED" - ] - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "maximumNumberOfPersons": { - "type": "integer", - "description": "maximumNumberOfPersons", - "format": "int32" - }, - "minimumNumberOfPersons": { - "type": "integer", - "description": "minimumNumberOfPersons", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the group ticket represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "GroupTicket" - }, - "prices": { - "type": "array", - "description": "Fare prices for the group ticket.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "pricingBasis": { - "type": "string", - "description": "Price basis", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "ticketing": { - "type": "string", - "description": "The type of way that tickets are issued to the group.", - "example": "SEPARATE_TICKETS", - "enum": [ - "ALL_ON_ONE_TICKET", - "SEPARATE_TICKETS", - "TICKET_WITH_COUPONS", - "OTHER" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the group ticket.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "The version of the group ticket.", - "example": "NSB:Version:V1" - } - }, - "description": "A GroupTicket" - }, - "GroupTicketInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "companionProfiles": { - "type": "array", - "description": "Companion Profiles in Group Ticket", - "items": { - "$ref": "#/components/schemas/CompanionProfile" - } - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupDiscountBasis": { - "type": "string", - "description": "groupDiscountBasis", - "enum": [ - "FREE", - "DISCOUNT_FOR_ALL", - "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", - "STEP_DISCOUNT", - "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" - ] - }, - "id": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:GroupTicket:FamilyDiscount" - }, - "jointCheckIn": { - "type": "string", - "description": "jointCheckIn", - "enum": [ - "NONE", - "ALLOWED", - "REQUIRED" - ] - }, - "maximumNumberOfPersons": { - "type": "integer", - "description": "maximumNumberOfPersons", - "format": "int32" - }, - "minimumNumberOfPersons": { - "type": "integer", - "description": "minimumNumberOfPersons", - "format": "int32" - }, - "name": { - "type": "array", - "description": "The name of the group ticket represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices for the group ticket.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "pricingBasis": { - "type": "string", - "description": "Price basis", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "ticketing": { - "type": "string", - "description": "The type of way that tickets are issued to the group.", - "example": "SEPARATE_TICKETS", - "enum": [ - "ALL_ON_ONE_TICKET", - "SEPARATE_TICKETS", - "TICKET_WITH_COUPONS", - "OTHER" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "version": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "The version of the group ticket.", - "example": "NSB:Version:V1" - } - }, - "description": "A group ticket create request" - }, - "IdAndVersion": { - "required": [ - "id", - "version" - ], - "type": "object", - "properties": { - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "ID of the element." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version of the element." - } - }, - "description": "Describes the ID and version of an element." - }, - "Interchanging": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fromMode": { - "type": "string", - "description": "Vehicle fromMode.", - "enum": [ - "AIR", - "BUS", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TRAM", - "UNKNOWN" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Interchanging:Trondelag" - }, - "maximumNumberOfChanges": { - "type": "integer", - "description": "MaximumNumberOfChanges.", - "format": "int32" - }, - "maximumTimeToMakeATransfer": { - "type": "string", - "description": "MaximumTimeToMakeATransfer" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Interchanging" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "toMode": { - "type": "string", - "description": "Vehicle toMode.", - "enum": [ - "AIR", - "BUS", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TRAM", - "UNKNOWN" - ] - }, - "typeOfUsageParameterRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "InterchangingInsert": { - "required": [ - "fareFrameRef", - "id", - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fromMode": { - "type": "string", - "description": "Vehicle fromMode.", - "enum": [ - "AIR", - "BUS", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TRAM", - "UNKNOWN" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Interchanging:Trondelag" - }, - "maximumNumberOfChanges": { - "type": "integer", - "description": "MaximumNumberOfChanges.", - "format": "int32" - }, - "maximumTimeToMakeATransfer": { - "type": "string", - "description": "MaximumTimeToMakeATransfer" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "toMode": { - "type": "string", - "description": "Vehicle toMode.", - "enum": [ - "AIR", - "BUS", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TRAM", - "UNKNOWN" - ] - }, - "typeOfUsageParameterRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "JourneyPattern": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "farePointsInPattern": { - "type": "array", - "description": "Fare points in pattern. Versioned child of JourneyPattern", - "items": { - "$ref": "#/components/schemas/FarePointInPattern" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:JourneyPattern:TrondheimOslo" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "FareSection" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A Journey Pattern" - }, - "LimitingRule": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "canBeCumulative": { - "type": "boolean", - "description": "CanBeCumulative." - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "discountAsPercentage": { - "type": "number", - "description": "DiscountAsPercentage.", - "format": "float" - }, - "discountAsValue": { - "type": "number", - "description": "DiscountAsValue.", - "format": "float" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id." - }, - "maximumPrice": { - "type": "string", - "description": "MaximumPrice.", - "example": "164.0" - }, - "maximumPriceAsPercentage": { - "type": "number", - "description": "MaximumPriceAsPercentage.", - "format": "double" - }, - "minimumLimitPrice": { - "type": "string", - "description": "MinimumLimitPrice.", - "example": "164.0" - }, - "minimumPrice": { - "type": "string", - "description": "MinimumPrice.", - "example": "164.0" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "LimitingRule" - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A LimitingRule" - }, - "ListTextInLanguage": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "LuggageAllowance": { - "required": [ - "changed", - "created", - "description", - "fareFrameRef", - "id", - "modification", - "name", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "baggageType": { - "type": "string", - "description": "Baggage Type", - "enum": [ - "HANDBAG", - "HAND_LUGGAGE", - "SMALL_SUITCASE", - "SUITCASE", - "TRUNK", - "OVERSIZE_ITEM", - "BICYCLE", - "SPORTING_EQUIPMENT", - "SKIS", - "MUSICAL_INSTRUMENT", - "PUSH_CHAIR", - "MOTORIZED_WHEELCHAIR", - "LARGE_MOTORIZED_WHEELCHAIR", - "WHEELCHAIR", - "SMALL_ANIMAL", - "ANIMAL", - "GAME", - "MOTORCYCLE", - "OTHER" - ] - }, - "baggageUseType": { - "type": "string", - "description": "Baggage Use Type", - "enum": [ - "CARRY_ON", - "CHECK_IN", - "OVERSIZE_CHECK_IN" - ] - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:LuggageAllowance:Bicycle" - }, - "luggageAllowanceType": { - "type": "string", - "description": "Luggage Allowance Type", - "enum": [ - "NONE", - "UNLIMITED", - "SINGLE", - "LIMITED" - ] - }, - "luggageChargingBasis": { - "type": "string", - "description": "Luggage Charging Basis", - "enum": [ - "FREE", - "CHARGED_BY_ITEM", - "CHARGED_BY_WEIGHT", - "OTHER" - ] - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "LuggageAllowance" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Prices for the luggage allowance.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "LuggageAllowance" - }, - "MapStringObject": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "Metadata": { - "required": [ - "created", - "id", - "nameOfClass", - "responsible", - "version" - ], - "type": "object", - "properties": { - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "externalReferenceName": { - "type": "string", - "description": "External reference name" - }, - "externalReferenceUrl": { - "type": "string", - "description": "External reference URL" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:SalesPackage:Ordinary" - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "JourneyPattern" - }, - "note": { - "type": "string", - "description": "Note", - "example": "Dette er en endring" - }, - "responsible": { - "minLength": 1, - "type": "string", - "description": "Responsible", - "example": "Kari Nordmann" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "MininmalVersionInfo": { - "required": [ - "changed", - "created", - "id", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "endDate": { - "type": "string", - "description": "EndDate", - "format": "date-time", - "readOnly": true - }, - "id": { - "type": "string", - "description": "Id.", - "readOnly": true, - "example": "NSB:ElementTypeMetadata:Test" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "ElementTypeMetadata" - }, - "startDate": { - "type": "string", - "description": "StartDate", - "format": "date-time", - "readOnly": true - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "type": "string", - "description": "Version", - "readOnly": true, - "example": "NSB:Version:V1" - } - }, - "description": "MininmalVersionInfo" - }, - "NameAndDescription": { - "required": [ - "description", - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - } - } - }, - "OnboardStay": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "duration": { - "type": "string", - "description": "Duration.", - "example": "PT24H" - }, - "fareClass": { - "type": "string", - "description": "Fareclass.", - "example": "FIRST_CLASS", - "enum": [ - "FIRST_CLASS", - "SECOND_CLASS", - "THIRD_CLASS", - "ECONOMY_CLASS", - "BUSINESS_CLASS", - "TURISTA", - "PREFERENTE", - "STANDARD_CLASS", - "PREMIUM_CLASS", - "ANY", - "UNKNOWN" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:OnboardStay:Sleeper" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "OnboardStay" - }, - "permission": { - "type": "string", - "description": "BoardingPermissionEnum.", - "example": "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE", - "enum": [ - "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE", - "DELAYEDALIGHTINGPOSSIBLEAFTERARRIVAL", - "OVERNIGHTSTAYONBOARDALLOWED" - ] - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "An OnboardStay" - }, - "ParameterPossibilitiesRequest": { - "type": "object", - "properties": { - "fareStructureElements": { - "type": "array", - "description": "Fare structure elements the user wants to retrieve the parameter alternatives for.", - "items": { - "$ref": "#/components/schemas/IdAndVersion" - } - }, - "preassignedFareProducts": { - "type": "array", - "description": "Preassigned products the user wants to retrieve the parameter alternatives for.", - "items": { - "$ref": "#/components/schemas/IdAndVersion" - } - }, - "salesPackages": { - "type": "array", - "description": "Sales packages the user wants to retrieve the parameter alternatives for.", - "items": { - "$ref": "#/components/schemas/IdAndVersion" - } - }, - "validableElements": { - "type": "array", - "description": "Validable elements the user wants to retrieve the parameter alternatives for.", - "items": { - "$ref": "#/components/schemas/IdAndVersion" - } - } - }, - "description": "Request for retrieving refunding alternatives for elements." - }, - "PenaltyPolicy": { - "required": [ - "changed", - "created", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "created": { - "type": "string", - "description": "Created", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:PenaltyPolicy:InspectionFeeYoung" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "minimumTimeBeforeReentry": { - "type": "string", - "description": "MinimumTimeBeforeReentry", - "example": "PT24H" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "NameOfClass", - "readOnly": true, - "example": "PenaltyPolicy" - }, - "paymentMethod": { - "type": "string", - "description": "PaymentMethod", - "example": "CASH" - }, - "penaltyAction": { - "type": "string", - "description": "PenaltyAction", - "example": "FINE" - }, - "penaltyPolicyType": { - "type": "string", - "description": "PenaltyPolicyType", - "example": "NO_TICKET" - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the penalty policy.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "sameStationReentryPolicyType": { - "type": "string", - "description": "SameStationReentryPolicyType", - "example": "BLOCKED" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfUsageParameterRef": { - "type": "string", - "description": "typeOfUsageParameter.", - "example": "ENT:TypeOfUsageParameter:OpenSeating" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A PENALTY POLICY" - }, - "PenaltyPolicyAlternatives": { - "required": [ - "penaltyOptions", - "ref" - ], - "type": "object", - "properties": { - "penaltyOptions": { - "type": "array", - "description": "Penalty policy alternatives for this element.", - "items": { - "$ref": "#/components/schemas/PenaltyPolicy" - } - }, - "ref": { - "$ref": "#/components/schemas/IdAndVersion" - } - }, - "description": "Penalty policy alternatives for an element." - }, - "PeriodTicketInfo": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:PreassignedFareProduct:30Days" - }, - "limitations": { - "type": "array", - "description": "Limitations as UsageParameters.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "PeriodTicket with userprofiles and usage validity periods" - }, - "PreassignedFareProduct": { - "required": [ - "accessRightParameterAssignments", - "accessRightsInProduct", - "changed", - "chargingMoment", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "validityConditions", - "vatGroupRegister" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef." - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "POINT_TO_POINT_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:PreassignedFareProduct:RuterSingleTicket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "PreassignedFareProduct" - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "productType": { - "type": "string", - "description": "The type of fare product.", - "example": "SINGLE_TRIP", - "enum": [ - "SINGLE_TRIP", - "TIME_LIMITED_SINGLE_TRIP", - "PERIOD_PASS" - ] - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT." - }, - "PreassignedFareProductInsert": { - "required": [ - "chargingMomentRef", - "fareFrameRef", - "id", - "name", - "operatorRef", - "organisation", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProductInsert" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "chargingMomentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummaryInsert" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:PreassignedFareProduct:RuterSingleTicket" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "operatorRef": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation." - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "productType": { - "type": "string", - "description": "The type of fare product.", - "example": "SINGLE_TRIP", - "enum": [ - "SINGLE_TRIP" - ] - }, - "typeOfFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "PreassignedFareProductPageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "Preassigned fare products for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/PreassignedFareProduct" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Requested page number.", - "format": "int32", - "example": 1 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "PreassignedFareProductWrapper" - }, - "PricingParameterSet": { - "required": [ - "changed", - "compatibleWithVersionRef", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:PricingParameterSet:123abc" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "TypeOfUsageParameter" - }, - "pricingrules": { - "type": "array", - "description": "Different rules that is common for the operator", - "items": { - "$ref": "#/components/schemas/PricingRuleEntity" - } - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "PricingRuleEntity": { - "type": "object", - "properties": { - "description": { - "$ref": "#/components/schemas/ListTextInLanguage" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "type": "string" - }, - "name": { - "$ref": "#/components/schemas/ListTextInLanguage" - }, - "version": { - "type": "string" - } - } - }, - "ProblemDetail": { - "type": "object", - "properties": { - "detail": { - "type": "string" - }, - "instance": { - "type": "string", - "format": "uri" - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "status": { - "type": "integer", - "format": "int32" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string", - "format": "uri" - } - } - }, - "ProductTreeExplained": { - "required": [ - "id", - "version" - ], - "type": "object", - "properties": { - "explainedElementId": { - "type": "string", - "description": "The netexId of the explained element", - "readOnly": true - }, - "explainedElementNameOfClass": { - "type": "string", - "description": "The nameOfClass of the explained element", - "readOnly": true - }, - "explainedElementVersion": { - "type": "string", - "description": "The version of the explained element", - "readOnly": true - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id for root component/element", - "readOnly": true, - "example": "NSB:SalesPackage:SomeSalesPackage" - }, - "messages": { - "$ref": "#/components/schemas/SeqExplainedMessageResponse" - }, - "nameOfClass": { - "minLength": 1, - "type": "string", - "description": "nameOfClass", - "readOnly": true, - "example": "SalesPackage" - }, - "originalErrorMessage": { - "type": "string", - "description": "The original error message thrown", - "readOnly": true - }, - "reason": { - "type": "string", - "description": "Reason for failed tree", - "readOnly": true, - "example": "invalidProductData" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version for root component/element", - "readOnly": true, - "example": "NSB:Version:V1" - } - }, - "description": "Schema for presenting explained messages for failed product trees" - }, - "PropertyOfDay": { - "required": [ - "countryRef", - "name" - ], - "type": "object", - "properties": { - "countryRef": { - "type": "string", - "description": "Reference to country for holiday. ISO 3166-1", - "readOnly": true, - "example": "NO" - }, - "dayOfYear": { - "type": "string", - "description": "Day of year", - "format": "##-##", - "example": "01-25" - }, - "daysOfWeek": { - "type": "array", - "description": "Days of week", - "items": { - "type": "string" - } - }, - "description": { - "type": "string", - "description": "Description of the property of day", - "example": "Days family discount is available" - }, - "holidayTypes": { - "type": "array", - "description": "Holiday types", - "items": { - "type": "string" - } - }, - "monthOfYear": { - "type": "integer", - "description": "Month of year", - "format": "int32", - "enum": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 9, - 10, - 11, - 12 - ] - }, - "name": { - "type": "string", - "description": "Name of property of day", - "example": "Monday" - } - }, - "description": "The DayType describe during which the assignment applies" - }, - "PurchaseWindow": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:PurchaseWindow:Child" - }, - "latestTime": { - "type": "string", - "description": "Latest time to purchase.", - "example": "23:59:59.999999999" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "maxmumPeriodBeforeDeparture": { - "type": "string", - "description": "Maximum period before departure.", - "example": "23:59:59.999999999" - }, - "minimumPeriodBeforeDeparture": { - "type": "string", - "description": "Minimum period before departure.", - "example": "01:59:59.999999999" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "PurchaseWindow Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "PurchaseWindow" - }, - "purchaseWhen": { - "type": "string", - "description": "When to purchase.", - "example": "ADVANCE_AND_DAY_OF_TRAVEL", - "enum": [ - "TIME_OF_TRAVEL_ONLY", - "DAY_OF_TRAVEL_ONLY", - "ADVANCE_ONLY", - "UNTIL_PREVIOUS_DAY", - "ADVANCE_AND_DAY_OF_TRAVEL", - "OTHER" - ] - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "PurchaseWindow version.", - "example": "NSB:Version:V1" - } - }, - "description": "A PurchaseWindow" - }, - "PurchaseWindowInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:PurchaseWindow:90days" - }, - "latestTime": { - "type": "string", - "description": "Latest time.", - "example": "23:59:59" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "maxmumPeriodBeforeDeparture": { - "type": "string", - "description": "Maximum period before departure.", - "example": "PT2160H" - }, - "minimumPeriodBeforeDeparture": { - "type": "string", - "description": "Minimum period before departure.", - "example": "PT2160H" - }, - "name": { - "type": "array", - "description": "PurchaseWindow Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "purchaseWhen": { - "type": "string", - "description": "When to purchase.", - "example": "ADVANCE_AND_DAY_OF_TRAVEL", - "enum": [ - "TIME_OF_TRAVEL_ONLY", - "DAY_OF_TRAVEL_ONLY", - "ADVANCE_ONLY", - "UNTIL_PREVIOUS_DAY", - "ADVANCE_AND_DAY_OF_TRAVEL", - "OTHER" - ] - }, - "version": { - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "PurchaseWindow version.", - "example": "NSB:Version:V1" - } - } - }, - "Refunding": { - "required": [ - "allowed", - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "allowed": { - "type": "string", - "description": "Allowed.", - "example": "FULL", - "enum": [ - "NONE", - "PARTIAL", - "FULL" - ] - }, - "canChangeClass": { - "type": "boolean", - "description": "Whether user can change class." - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "exchangeableFromAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded from any point after purchase." - }, - "exchangeableFromDuration": { - "type": "string", - "description": "Exchangeable from duration.", - "example": "PT24H" - }, - "exchangeableUntilAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded until any point after purchase." - }, - "exchangeableUntilDuration": { - "type": "string", - "description": "Exchangeable until duration." - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "hasFee": { - "type": "boolean", - "description": "Has fee." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Refunding:FullRefundUntilLimit" - }, - "limitingRule": { - "type": "string", - "description": "Pricing rule." - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Refunding" - }, - "onlyAtCertainDistributionPoints": { - "type": "boolean", - "description": "Whether distribution is restricted to certain points." - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the refunding rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "refundBasis": { - "type": "string", - "description": "Basis on which refund is made. See allowed values below.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "refundType": { - "type": "string", - "description": "Refund type.", - "example": "UNUSED", - "enum": [ - "UNUSED", - "DELAY", - "CANCELLATION", - "PARTIAL_JOURNEY", - "OTHER" - ] - }, - "resellWhen": { - "type": "string", - "description": "Event marking when the refundable status of the ticket changes.", - "example": "NEVER", - "enum": [ - "NEVER", - "BEFORE_START_OF_VALIDITY_PERIOD", - "AFTER_START_OF_VALIDITY_PERIOD", - "AFTER_END_OF_VALIDITY_PERIOD", - "BEFORE_FIRST_USE", - "AFTER_FIRST_USE", - "BEFORE_VALIDATION", - "AFTER_VALIDATION", - "AFTER_PURCHASE" - ] - }, - "status": { - "type": "string", - "description": "Refunding status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "unusedTicketsOnly": { - "type": "boolean", - "description": "Unused tickets only." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Refunding version.", - "example": "NSB:Version:V1" - } - }, - "description": "Refunding" - }, - "RefundingAlternatives": { - "required": [ - "ref", - "refundingOptions" - ], - "type": "object", - "properties": { - "ref": { - "$ref": "#/components/schemas/IdAndVersion" - }, - "refundingOptions": { - "type": "array", - "description": "Refunding alternatives for this element.", - "items": { - "$ref": "#/components/schemas/Refunding" - } - } - }, - "description": "Refunding alternatives for an element." - }, - "RefundingInsert": { - "required": [ - "allowed", - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "allowed": { - "type": "string", - "description": "Allowed.", - "example": "FULL", - "enum": [ - "NONE", - "PARTIAL", - "FULL" - ] - }, - "canChangeClass": { - "type": "boolean", - "description": "Whether user can change class." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "exchangeableFromAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded from any point after purchase." - }, - "exchangeableFromDuration": { - "type": "string", - "description": "Exchangeable from duration." - }, - "exchangeableUntilAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded until any point after purchase." - }, - "exchangeableUntilDuration": { - "type": "string", - "description": "Exchangeable until duration." - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "hasFee": { - "type": "boolean", - "description": "Has fee." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:Refunding:SeatUpgrade" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "onlyAtCertainDistributionPoints": { - "type": "boolean", - "description": "Whether distribution is restricted to certain points." - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the refunding rule.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "refundBasis": { - "type": "string", - "description": "Basis on which refund is made. See allowed values below.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "refundType": { - "type": "string", - "description": "Refund type.", - "example": "UNUSED", - "enum": [ - "UNUSED", - "DELAY", - "CANCELLATION", - "PARTIAL_JOURNEY", - "OTHER" - ] - }, - "resellWhen": { - "type": "string", - "description": "Event marking when the refundable status of the ticket changes.", - "example": "NEVER", - "enum": [ - "NEVER", - "BEFORE_START_OF_VALIDITY_PERIOD", - "AFTER_START_OF_VALIDITY_PERIOD", - "AFTER_END_OF_VALIDITY_PERIOD", - "BEFORE_FIRST_USE", - "AFTER_FIRST_USE", - "BEFORE_VALIDATION", - "AFTER_VALIDATION,AFTER_PURCHASE" - ] - }, - "unusedTicketsOnly": { - "type": "boolean", - "description": "Unused tickets only." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UsageValidityPeriod version.", - "example": "NSB:Version:V1" - } - } - }, - "Replacing": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "allowed": { - "type": "string", - "description": "Allowed.", - "enum": [ - "NONE", - "PARTIAL", - "FULL" - ] - }, - "canChangeClass": { - "type": "boolean", - "description": "Whether user can change class." - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "exchangeableFromAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded from any point after purchase." - }, - "exchangeableFromDuration": { - "type": "string", - "description": "Exchangeable from duration.", - "example": "PT24H" - }, - "exchangeableUntilAnyTime": { - "type": "boolean", - "description": "Can be exchanged or refunded until any point after purchase." - }, - "exchangeableUntilDuration": { - "type": "string", - "description": "Exchangeable until duration." - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare table.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "hasFee": { - "type": "boolean", - "description": "Has fee." - }, - "id": { - "minLength": 1, - "type": "string", - "description": "Id.", - "example": "NSB:Replacing:SomeId" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "Replacing" - }, - "onlyAtCertainDistributionPoints": { - "type": "boolean", - "description": "Whether distribution is restricted to certain points." - }, - "prices": { - "type": "array", - "description": "Fare prices for the replacing.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "refundBasis": { - "type": "string", - "description": "Basis on which refund is made. See allowed values below.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "resellWhen": { - "type": "string", - "description": "Event marking when the exchangeable status of the ticket changes.", - "example": "NEVER", - "enum": [ - "NEVER", - "BEFORE_START_OF_VALIDITY_PERIOD", - "AFTER_START_OF_VALIDITY_PERIOD", - "AFTER_END_OF_VALIDITY_PERIOD", - "BEFORE_FIRST_USE", - "AFTER_FIRST_USE", - "BEFORE_VALIDATION", - "AFTER_VALIDATION", - "AFTER_PURCHASE" - ] - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "unusedTicketsOnly": { - "type": "boolean", - "description": "Unused tickets only." - }, - "validityConditions": { - "type": "array", - "description": "Gives a sequence of conditions for validity.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "type": "string", - "description": "The version of the replacing.", - "example": "ENT:Version:SomeVersion" - } - }, - "description": "A Replacing" - }, - "Reserving": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "feeBasis": { - "type": "string", - "description": "Fee basis.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Reserving:SeatAsAccommodationReserving" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "maximumNumberToReserve": { - "type": "integer", - "description": "Maximum amount to reserve.", - "format": "int32" - }, - "minimumNumberToReserve": { - "type": "integer", - "description": "Minimum amount to reserve.", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "mustReserveWholeCompartment": { - "type": "boolean", - "description": "Must reserve whole compartment" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Reserving" - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the reserving rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "reservationChargeType": { - "type": "string", - "description": "Type of charge for reservation.", - "example": "NONE", - "enum": [ - "NONE", - "SINGLE_FEE_FOR_RETURN_TRIP", - "FEE_FOR_EACH_DIRECTION", - "FEE_FOR_EACH_LEG" - ] - }, - "reservingRequirements": { - "type": "string", - "description": "Requirements for reservation.", - "example": "RESERVATIONS_COMPULSORY", - "enum": [ - "RESERVATIONS_COMPULSORY", - "RESERVATIONS_COMPULSORY_FOR_GROUPS", - "RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS", - "RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION", - "RESERVATIONS_RECOMMENDED", - "RESERVATIONS_POSSIBLE", - "RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS", - "RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS", - "RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES", - "GROUP_BOOKING_RESTRICTED", - "NO_GROUPS_ALLOWED", - "NO_RESERVATIONS_POSSIBLE", - "WHEELCHAIR_ONLY_RESERVATIONS", - "BICYCLE_RESERVATIONS_COMPULSORY", - "RESERVATION_SUPPLEMENT_CHARGED" - ] - }, - "status": { - "type": "string", - "description": "Reserving status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "Type of usage parameter for the reservation.", - "example": "NSB:TypeOfUsageParameter:OpenSeating" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Reserving version.", - "example": "NSB:Version:V1" - } - }, - "description": "Reserving" - }, - "ReservingInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "feeBasis": { - "type": "string", - "description": "Fee basis.", - "example": "PER_OFFER", - "enum": [ - "PER_OFFER", - "PER_PERSON" - ] - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Reserving:SeatAsAccommodationReserving" - }, - "maximumNumberToReserve": { - "type": "integer", - "description": "Maximum amount to reserve.", - "format": "int32" - }, - "minimumNumberToReserve": { - "type": "integer", - "description": "Minimum amount to reserve.", - "format": "int32" - }, - "mustReserveWholeCompartment": { - "type": "boolean", - "description": "Must reserve whole compartment" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Prices for the reserving.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "reservationChargeType": { - "type": "string", - "description": "Type of charge for reservation.", - "example": "NONE", - "enum": [ - "NONE", - "SINGLE_FEE_FOR_RETURN_TRIP", - "FEE_FOR_EACH_DIRECTION", - "FEE_FOR_EACH_LEG" - ] - }, - "reservingRequirements": { - "type": "string", - "description": "Requirements for reservation.", - "example": "RESERVATIONS_COMPULSORY", - "enum": [ - "RESERVATIONS_COMPULSORY", - "RESERVATIONS_COMPULSORY_FOR_GROUPS", - "RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS", - "RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION", - "RESERVATIONS_RECOMMENDED", - "RESERVATIONS_POSSIBLE", - "RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS", - "RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS", - "RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES", - "GROUP_BOOKING_RESTRICTED", - "NO_GROUPS_ALLOWED", - "NO_RESERVATIONS_POSSIBLE", - "WHEELCHAIR_ONLY_RESERVATIONS", - "BICYCLE_RESERVATIONS_COMPULSORY", - "RESERVATION_SUPPLEMENT_CHARGED" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "Type of usage parameter for the reservation.", - "example": "NSB:TypeOfUsageParameter:ThroughFareInterchanging" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Reserving version.", - "example": "NSB:Version:V1" - } - } - }, - "Reverting": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "allowedAfterControl": { - "type": "boolean", - "description": "Specifies if revert is allowed after control.", - "example": true, - "default": false - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "type": "string", - "description": "Id.", - "example": "NSB:Reverting:SelfService" - }, - "maximumTimeAfterUse": { - "type": "string", - "description": "Maximum time after use Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "minimumTimeAfterUse": { - "type": "string", - "description": "Minimum time after use. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "Reverting" - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the reverting rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Reverting status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfResponsibilityRoleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter.", - "example": "ENT:TypeOfUsageParameter:OpenSeating" - }, - "version": { - "minLength": 1, - "type": "string", - "description": "Reverting version.", - "example": "NSB:Version:V1" - } - }, - "description": "Reverting" - }, - "RoundTrip": { - "required": [ - "changed", - "created", - "doubleSingleFare", - "fareFrameRef", - "id", - "isRequired", - "modification", - "nameOfClass", - "shortTrip", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "doubleSingleFare": { - "type": "boolean", - "description": "Double single fare", - "example": true - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the round trip.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:RoundTrip:Child" - }, - "isRequired": { - "type": "boolean", - "description": "Is required." - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "RoundTrip Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "RoundTrip" - }, - "prices": { - "type": "array", - "description": "Fare prices for the round trip.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "required": { - "type": "boolean" - }, - "shortTrip": { - "type": "boolean", - "description": "Short trip", - "example": true - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "tripType": { - "type": "string", - "description": "Type of round trip", - "enum": [ - "SINGLE", - "RETURN", - "RETURN_ONLY", - "MULTIPLE" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the round trip.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "RoundTrip version.", - "example": "NSB:Version:V1" - } - }, - "description": "A RoundTrip" - }, - "RoundTripInsert": { - "required": [ - "doubleSingleFare", - "fareFrameRef", - "id", - "isRequired", - "name", - "shortTrip", - "version" - ], - "type": "object", - "properties": { - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "example": "NSB:Version:V1" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "example": "NSB:Version:V1" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "doubleSingleFare": { - "type": "boolean", - "description": "Double single fare", - "example": true - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the round trip.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:RoundTrip:Child" - }, - "isRequired": { - "type": "boolean", - "description": "Is required." - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "name": { - "type": "array", - "description": "Round trip Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices for the round trip.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "required": { - "type": "boolean" - }, - "shortTrip": { - "type": "boolean", - "description": "Short trip", - "example": true - }, - "tripType": { - "type": "string", - "description": "Type of round trip", - "enum": [ - "SINGLE", - "RETURN", - "RETURN_ONLY", - "MULTIPLE" - ] - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the round trip.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Round trip version.", - "example": "NSB:Version:V1" - } - }, - "description": "A RoundTrip create request" - }, - "Rounding": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "roundingMethod", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Rounding:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "Rounding" - }, - "roundingMethod": { - "type": "string", - "description": "Type of rounding.", - "enum": [ - "NONE", - "DOWN", - "UP", - "SPLIT", - "STEP_TABLE", - "FIVE", - "NINE", - "TEN", - "FORTY_NINE" - ] - }, - "roundingModulus": { - "type": "number", - "description": "Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.", - "format": "double" - }, - "status": { - "type": "string", - "description": "Rounding status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Rounding version.", - "example": "NSB:Version:V1" - } - }, - "description": "A description of how prices are rounded post calculation", - "deprecated": true - }, - "RoundingInsert": { - "required": [ - "fareFrameRef", - "id", - "roundingMethod", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Rounding:Ordinary" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "roundingMethod": { - "type": "string", - "description": "Type of rounding.", - "enum": [ - "NONE", - "DOWN", - "UP", - "SPLIT", - "STEP_TABLE", - "FIVE", - "NINE", - "TEN", - "FORTY_NINE" - ] - }, - "roundingModulus": { - "type": "number", - "description": "Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.", - "format": "double" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Rounding version.", - "example": "NSB:Version:V1" - } - }, - "description": "Rounding.", - "deprecated": true - }, - "SaleDiscountRight": { - "required": [ - "accessRightParameterAssignments", - "accessRightsInProduct", - "changed", - "chargingMoment", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "organisation", - "prices", - "status", - "validityConditions", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "SalesPackage changed datetime.", - "readOnly": true - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef", - "readOnly": true - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "SalesPackage create datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:PreassignedFareProduct:RuterSingleTicket" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "PreassignedFareProduct" - }, - "operatorRef": { - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation who own the product." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Prices for the sdr.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "typeOfFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validationRequirements": { - "type": "string", - "description": "A set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", - "example": "[\"IDENTIFIABLE_CUSTOMER\"]" - }, - "validityConditions": { - "type": "array", - "description": "ValidityCondition.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A Sale Discount Right response" - }, - "SaleDiscountRightPageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "SaleDiscountRights for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/SeqSaleDiscountRight" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Number of the requested page. In case state is lost", - "format": "int32", - "readOnly": true, - "example": 13 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "readOnly": true, - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "SaleDiscountRightPageWrapper" - }, - "SalesPackage": { - "required": [ - "accessRightParameterAssignments", - "changed", - "created", - "distributionAssignments", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "Access Right Parameter assignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active for this SP.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "SalesPackage changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "created": { - "type": "string", - "description": "SalesPackage create datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionAssignments": { - "type": "array", - "description": "Distribution assignments.", - "items": { - "$ref": "#/components/schemas/DistributionAssignment" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SalesPackage:Ordinary" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "SalesPackage Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "SalesPackage" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "salesPackageElements": { - "type": "array", - "description": "Sales package elements.", - "items": { - "$ref": "#/components/schemas/SalesPackageElement" - } - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is optional. No default value", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A SalesPackage response" - }, - "SalesPackageElement": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SalesPackageElement:Ordinary" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "SalesPackageElement" - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfTravelDocumentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A SalesPackageElement" - }, - "SalesPackageElementInsert": { - "required": [ - "fareFrameRef", - "fareTableRefs", - "id", - "name" - ], - "type": "object", - "properties": { - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SalesPackageElement:Ordinary" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "typeOfTravelDocumentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "SalesPackageInsert": { - "required": [ - "accessRightParameterAssignmentRefs", - "distributionAssignments", - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionAssignments": { - "type": "array", - "description": "Distribution assignments.", - "items": { - "$ref": "#/components/schemas/DistributionAssignmentInsert" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:UserProfile:Child" - }, - "name": { - "type": "array", - "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "salesPackageElements": { - "type": "array", - "description": "Sales package elements.", - "items": { - "$ref": "#/components/schemas/SalesPackageElementInsert" - } - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is optional. No default", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UserProfile version.", - "example": "NSB:Version:V1" - } - } - }, - "SalesPackagePageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "SalesPackages for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/v2.SalesPackage" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Number of the requested page. In case state is lost", - "format": "int32", - "readOnly": true, - "example": 13 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "readOnly": true, - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "SalesPackagePageWrapper" - }, - "ScopingValidityParameter": { - "required": [ - "changed", - "created", - "fareFrameRef", - "genericParameterAssignmentRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "authorityRef": { - "type": "string", - "description": "AuthorityRef.", - "example": "NSB:Authority:NSB" - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "distributionChannelRef": { - "type": "string", - "description": "Distribution channel ref.", - "example": "ENT:DistributionChannel:App" - }, - "facilitySetRef": { - "type": "string", - "description": "facilitySetRef." - }, - "fareClasses": { - "type": "array", - "description": "FareClasses. Enum as string with the following values: FIRST_CLASS, SECOND_CLASS, THIRD_CLASS, ECONOMY_CLASS, BUSINESS_CLASS, TURISTA, PREFERENTE, STANDARD_CLASS, PREMIUM_CLASS, ANY, UNKNOWN", - "items": { - "type": "string" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareSectionRef": { - "type": "string", - "description": "Fare section ref." - }, - "fareZoneRef": { - "type": "string", - "description": "FareZoneRef.", - "example": "KOL:FareZone:250" - }, - "genericParameterAssignmentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfLinesRef": { - "type": "string", - "description": "Group of Lines ref.", - "example": "ENT:GroupOfLines:AllLines" - }, - "groupOfTariffZonesRef": { - "type": "string", - "description": "Group of Tariff Zones ref.", - "example": "ENT:GroupOfTariffZones:AllZones" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ScopingValidityParameter:OperatorNSB" - }, - "lineRef": { - "type": "string", - "description": "LineRef." - }, - "lineType": { - "type": "string", - "description": "LineType.", - "example": "EXPRESS", - "enum": [ - "LOCAL", - "URBAN", - "LONG_DISTANCE", - "EXPRESS", - "SEASONAL", - "REPLACEMENT", - "FLEXIBLE", - "CORRIDOR_SERVICE", - "MAIN_ROUTE_WITH_FLEXIBLE_ENDS", - "FLEXIBLE_AREAS_ONLY", - "HAIL_AND_RIDE_SECTIONS", - "FIXED_STOP_AREA_WIDE", - "FREE_AREA_AREA_WIDE", - "MIXED_FLEXIBLE", - "MIXED_FLEXIBLE_AND_FIXED", - "FIXED", - "OTHER" - ] - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "ScopingValidityParameter" - }, - "operatorRef": { - "type": "string", - "description": "Operator referance." - }, - "placeUse": { - "type": "string", - "description": "PlaceUse", - "enum": [ - "START_AT", - "END_AT", - "VIA", - "RESTRICT_TO", - "OTHER" - ] - }, - "scheduledStopPointRef": { - "type": "string", - "description": "Scheduled stop Point ref." - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "tariffZoneRef": { - "type": "string", - "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef.", - "example": "RUT:TariffZone:2S", - "deprecated": true - }, - "topographicPlaceRef": { - "type": "string", - "description": "TopographicPlaceRef" - }, - "transportSubmode": { - "type": "string", - "description": "TransportSubmode.", - "example": "expressBus", - "enum": [ - "unknown", - "undefined", - "internationalFlight", - "domesticFlight", - "intercontinentalFlight", - "domesticScheduledFlight", - "shuttleFlight", - "intercontinentalCharterFlight", - "internationalCharterFlight", - "roundTripCharterFlight", - "sightseeingFlight", - "helicopterService", - "domesticCharterFlight", - "SchengenAreaFlight", - "airshipService", - "shortHaulInternationalFlight", - "canalBarge", - "localBus", - "regionalBus", - "expressBus", - "nightBus", - "postBus", - "specialNeedsBus", - "mobilityBus", - "mobilityBusForRegisteredDisabled", - "sightseeingBus", - "shuttleBus", - "highFrequencyBus", - "dedicatedLaneBus", - "schoolBus", - "schoolAndPublicServiceBus", - "railReplacementBus", - "demandAndResponseBus", - "airportLinkBus", - "internationalCoach", - "nationalCoach", - "shuttleCoach", - "regionalCoach", - "specialCoach", - "schoolCoach", - "sightseeingCoach", - "touristCoach", - "commuterCoach", - "funicular", - "streetCableCar", - "allFunicularServices", - "undefinedFunicular", - "metro", - "tube", - "urbanRailway", - "cityTram", - "localTram", - "regionalTram", - "sightseeingTram", - "shuttleTram", - "trainTram", - "telecabin", - "cableCar", - "lift", - "chairLift", - "dragLift", - "telecabinLink", - "local", - "highSpeedRail", - "suburbanRailway", - "regionalRail", - "interregionalRail", - "longDistance", - "international", - "sleeperRailService", - "nightRail", - "carTransportRailService", - "touristRailway", - "airportLinkRail", - "railShuttle", - "replacementRailService", - "specialTrain", - "crossCountryRail", - "rackAndPinionRailway", - "internationalCarFerry", - "nationalCarFerry", - "regionalCarFerry", - "localCarFerry", - "internationalPassengerFerry", - "nationalPassengerFerry", - "regionalPassengerFerry", - "localPassengerFerry", - "postBoat", - "trainFerry", - "roadFerryLink", - "airportBoatLink", - "highSpeedVehicleService", - "highSpeedPassengerService", - "sightseeingService", - "schoolBoat", - "cableFerry", - "riverBus", - "scheduledFerry", - "shuttleFerryService", - "communalTaxi", - "charterTaxi", - "waterTaxi", - "railTaxi", - "bikeTaxi", - "blackCab", - "miniCab", - "allTaxiServices", - "hireCar", - "hireVan", - "hireMotorbike", - "hireCycle", - "allHireVehicles" - ] - }, - "vehicleMode": { - "type": "string", - "description": "VehicleModeRef.", - "enum": [ - "AIR", - "BUS", - "COACH", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TAXI", - "TRAM", - "UNKNOWN" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A ScopingValidityParameter" - }, - "ScopingValidityParameterInsert": { - "required": [ - "id", - "version" - ], - "type": "object", - "properties": { - "authorityRef": { - "type": "string", - "description": "AuthorityRef.", - "example": "NSB:Authority:NSB" - }, - "changed": { - "type": "string", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "distributionChannelRef": { - "type": "string", - "description": "Reference to a DISTRIBUTION CHANNEL to which the ACCESS RIGHT PARAMETER ASSIGNMENTs applies.", - "example": "ENT:DistributionChannel:App" - }, - "facilitySetRef": { - "type": "string", - "description": "facilitySetRef." - }, - "fareClasses": { - "type": "array", - "description": "Fare class list.", - "items": { - "type": "string" - } - }, - "fareSectionRef": { - "type": "string", - "description": "Fare section ref." - }, - "fareZoneRef": { - "type": "string", - "description": "FareZoneRef.", - "example": "KOL:FareZone:250" - }, - "groupOfLinesRef": { - "type": "string", - "description": "Group of lines ref.", - "example": "ENT:GroupOfLines:AllLines" - }, - "groupOfTariffZonesRef": { - "type": "string", - "description": "Group of Tariff Zones ref", - "example": "ENT:GroupOfTariffZones:AllZones" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ScopingValidityParameter:OperatorNSB" - }, - "lineRef": { - "type": "string", - "description": "LineRef." - }, - "lineType": { - "type": "string", - "description": "LineType.", - "example": "EXPRESS", - "enum": [ - "LOCAL", - "URBAN", - "LONG_DISTANCE", - "EXPRESS", - "SEASONAL", - "REPLACEMENT", - "FLEXIBLE", - "CORRIDOR_SERVICE", - "MAIN_ROUTE_WITH_FLEXIBLE_ENDS", - "FLEXIBLE_AREAS_ONLY", - "HAIL_AND_RIDE_SECTIONS", - "FIXED_STOP_AREA_WIDE", - "FREE_AREA_AREA_WIDE", - "MIXED_FLEXIBLE", - "MIXED_FLEXIBLE_AND_FIXED", - "FIXED", - "OTHER" - ] - }, - "nameOfClass": { - "type": "string" - }, - "operatorRef": { - "type": "string", - "description": "Operator referance." - }, - "placeUse": { - "type": "string", - "description": "PlaceUse", - "enum": [ - "START_AT", - "END_AT", - "VIA", - "RESTRICT_TO", - "OTHER" - ] - }, - "scheduledStopPointRef": { - "type": "string", - "description": "Scheduled stop Point ref." - }, - "tariffZoneRef": { - "type": "string", - "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef", - "example": "RUT:TariffZone:2S", - "deprecated": true - }, - "topographicPlaceRef": { - "type": "string", - "description": "TopographicPlaceRef" - }, - "transportSubmode": { - "type": "string", - "description": "TransportSubmode.", - "example": "expressBus", - "enum": [ - "unknown", - "undefined", - "internationalFlight", - "domesticFlight", - "intercontinentalFlight", - "domesticScheduledFlight", - "shuttleFlight", - "intercontinentalCharterFlight", - "internationalCharterFlight", - "roundTripCharterFlight", - "sightseeingFlight", - "helicopterService", - "domesticCharterFlight", - "SchengenAreaFlight", - "airshipService", - "shortHaulInternationalFlight", - "canalBarge", - "localBus", - "regionalBus", - "expressBus", - "nightBus", - "postBus", - "specialNeedsBus", - "mobilityBus", - "mobilityBusForRegisteredDisabled", - "sightseeingBus", - "shuttleBus", - "highFrequencyBus", - "dedicatedLaneBus", - "schoolBus", - "schoolAndPublicServiceBus", - "railReplacementBus", - "demandAndResponseBus", - "airportLinkBus", - "internationalCoach", - "nationalCoach", - "shuttleCoach", - "regionalCoach", - "specialCoach", - "schoolCoach", - "sightseeingCoach", - "touristCoach", - "commuterCoach", - "funicular", - "streetCableCar", - "allFunicularServices", - "undefinedFunicular", - "metro", - "tube", - "urbanRailway", - "cityTram", - "localTram", - "regionalTram", - "sightseeingTram", - "shuttleTram", - "trainTram", - "telecabin", - "cableCar", - "lift", - "chairLift", - "dragLift", - "telecabinLink", - "local", - "highSpeedRail", - "suburbanRailway", - "regionalRail", - "interregionalRail", - "longDistance", - "international", - "sleeperRailService", - "nightRail", - "carTransportRailService", - "touristRailway", - "airportLinkRail", - "railShuttle", - "replacementRailService", - "specialTrain", - "crossCountryRail", - "rackAndPinionRailway", - "internationalCarFerry", - "nationalCarFerry", - "regionalCarFerry", - "localCarFerry", - "internationalPassengerFerry", - "nationalPassengerFerry", - "regionalPassengerFerry", - "localPassengerFerry", - "postBoat", - "trainFerry", - "roadFerryLink", - "airportBoatLink", - "highSpeedVehicleService", - "highSpeedPassengerService", - "sightseeingService", - "schoolBoat", - "cableFerry", - "riverBus", - "scheduledFerry", - "shuttleFerryService", - "communalTaxi", - "charterTaxi", - "waterTaxi", - "railTaxi", - "bikeTaxi", - "blackCab", - "miniCab", - "allTaxiServices", - "hireCar", - "hireVan", - "hireMotorbike", - "hireCycle", - "allHireVehicles" - ] - }, - "vehicleMode": { - "type": "string", - "description": "VehicleModeRef.", - "enum": [ - "AIR", - "BUS", - "COACH", - "CABLE_WAY", - "WATER", - "FUNICULAR", - "LIFT", - "RAIL", - "METRO", - "TAXI", - "TRAM", - "UNKNOWN" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A ScopingValidityParameter" - }, - "SecurityPolicy": { - "required": [ - "changed", - "created", - "id", - "minimumAccountSecurityLevel", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:SecurityPolicy:HighValueProduct" - }, - "minimumAccountSecurityLevel": { - "type": "integer", - "description": "Required (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "NameOfClass", - "readOnly": true, - "example": "SecurityPolicy" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "SeqExplainedMessageResponse": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - }, - "description": "Translated messages explaining the failure", - "readOnly": true - }, - "SeqGeographicalIntervalInsert": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "SeqSaleDiscountRight": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "SeqStatusFilterEnum": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "SeqUVPForNumberOfZonesInsert": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "SeqUsageValidityPeriodInsert": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "ServiceFacilitySet": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "accommodation": { - "$ref": "#/components/schemas/Accommodation" - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:ServiceFacilitySet:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "ServiceFacilitySet" - }, - "onboardStay": { - "$ref": "#/components/schemas/OnboardStay" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A ServiceFacilitySet" - }, - "SetString": { - "type": "object", - "properties": { - "empty": { - "type": "boolean" - }, - "traversableAgain": { - "type": "boolean" - } - } - }, - "SteppedDuration": { - "required": [ - "initialDuration", - "stepUnit", - "subsequentStepsDuration" - ], - "type": "object", - "properties": { - "initialDuration": { - "type": "string", - "description": "Initial duration. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "maximumDuration": { - "type": "string", - "description": "Maximum duration. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "stepUnit": { - "type": "string", - "description": "Step unit.", - "example": "ZONES", - "enum": [ - "STOPS", - "STOPS_INCLUDING_PASS_THROUGH_STOPS", - "SECTIONS", - "ZONES", - "NETWORKS", - "OPERATORS", - "COUNTRIES" - ] - }, - "subsequentStepsDuration": { - "type": "string", - "description": "Subsequent duration. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - } - }, - "description": "Stepped duration." - }, - "SupplementProduct": { - "required": [ - "accessRightParameterAssignments", - "accessRightsInProduct", - "changed", - "chargingMoment", - "created", - "fareFrameRef", - "fareProductRefs", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "organisation", - "pricingRuleRef", - "status", - "validityConditions", - "vatGroup", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "accessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "accessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "chargingMoment": { - "$ref": "#/components/schemas/ChargingMoment" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareProductRefs": { - "type": "array", - "description": "fareProductRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType", - "example": "POINT_TO_POINT_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "Reference to information about the fare.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SupplementProduct:BicycleReserving" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "SupplementProduct" - }, - "operatorRef": { - "type": "string", - "description": "The reference to the operator.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "type": "string", - "description": "Organisation." - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "pricingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "privateCode": { - "type": "string", - "description": "Privat code." - }, - "status": { - "type": "string", - "description": "Supplement product status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "supplementProductType": { - "type": "string", - "description": "The type of supplement product for which the supplement product belongs to.", - "enum": [ - "SEAT_RESERVATION", - "BICYCLE", - "DOG", - "ANIMAL", - "MEAL", - "WIFI", - "EXTRA_LUGGAGE", - "PENALTY", - "UPGRADE", - "JOURNEY_EXTENSION", - "JOURNEY_ADD_ON", - "EVENT_ADD_ON", - "PARKING" - ] - }, - "typeOfFareProduct": { - "$ref": "#/components/schemas/TypeOfFareProduct" - }, - "validityConditions": { - "type": "array", - "description": "validityConditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "vatGroup": { - "type": "string", - "description": "The VAT group for the SupplementProduct.", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Supplement product version.", - "example": "NSB:Version:V1" - } - }, - "description": "A SUPPLEMENT PRODUCT consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT and FARE PRODUCT" - }, - "SupplementProductInsert": { - "required": [ - "chargingMomentRef", - "fareFrameRef", - "id", - "name", - "operatorRef", - "organisation", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignmentRefs": { - "type": "array", - "description": "AccessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "AccessRightsInProduct.", - "items": { - "$ref": "#/components/schemas/AccessRightInProductInsert" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "chargingMomentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummaryInsert" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType.", - "example": "ZONE_TO_ZONE_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "FareTableRef.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SupplementProduct:LargeAnimal" - }, - "name": { - "type": "array", - "description": "Name.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "operatorRef": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "OperatorRef.", - "example": "RUT:Authority:RUT" - }, - "organisation": { - "minLength": 1, - "type": "string", - "description": "Organisation." - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "privateCode": { - "type": "string", - "description": "PrivateCode." - }, - "supplementProductType": { - "type": "string", - "description": "SupplementProductType.", - "example": "SEAT_RESERVATION", - "enum": [ - "SEAT_RESERVATION", - "BICYCLE", - "DOG", - "ANIMAL", - "MEAL", - "WIFI", - "EXTRA_LUGGAGE", - "PENALTY", - "UPGRADE", - "JOURNEY_EXTENSION", - "JOURNEY_ADD_ON", - "EVENT_ADD_ON", - "PARKING" - ] - }, - "typeOfFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT", - "default": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "Tariff": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Tariff:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Tariff Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "Tariff" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "returnFareTwiceSingle": { - "type": "boolean", - "description": "returnFareTwiceSingle" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "tariffBasis": { - "type": "string", - "description": "TariffBasis.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "validBetweenRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Tariffs version.", - "example": "NSB:Version:V1" - } - }, - "description": "A tariff" - }, - "TariffInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "validBetweenRef", - "version" - ], - "type": "object", - "properties": { - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:Tariff:Ordinary" - }, - "name": { - "type": "array", - "description": "Tariff Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "returnFareTwiceSingle": { - "type": "boolean", - "description": "returnFareTwiceSingle" - }, - "tariffBasis": { - "type": "string", - "description": "TariffBasis.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "validBetweenRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Tariff version.", - "example": "NSB:Version:V1" - } - } - }, - "TemporalValidityParameter": { - "required": [ - "changed", - "created", - "genericParameterAssignmentRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "CompatibleWithVersionRef" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "dayType": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "genericParameterAssignmentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfTimeBands": { - "$ref": "#/components/schemas/GroupOfTimeBands" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TemporalValidityParameter:OperatorNSB" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "TemporalValidityParameter" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityCondition": { - "$ref": "#/components/schemas/ValidityCondition" - }, - "validityConditionRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A TemporalValidityParameter" - }, - "TemporalValidityParameterInsert": { - "required": [ - "id", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "format": "date-time" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "dayType": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfTimeBands": { - "$ref": "#/components/schemas/GroupOfTimeBands" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TemporalValidityParameter:OperatorNSB" - }, - "nameOfClass": { - "type": "string" - }, - "validityCondition": { - "$ref": "#/components/schemas/ValidityCondition" - }, - "validityConditionRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "A TemporalValidityParameter" - }, - "TextInLanguage": { - "required": [ - "lang", - "value" - ], - "type": "object", - "properties": { - "lang": { - "minLength": 1, - "type": "string", - "description": "Language code.", - "example": "nob" - }, - "value": { - "minLength": 1, - "type": "string", - "description": "The text." - } - }, - "description": "Text in a specific language." - }, - "Timeband": { - "required": [ - "changed", - "created", - "dayOffset", - "description", - "endTime", - "fareFrameRef", - "id", - "modification", - "name", - "nameOfClass", - "startTime", - "status" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "dayOffset": { - "type": "integer", - "description": "Days offset. This will determine if endTime is x number of days from today. ie. 1 is tomorrow 0 is today.", - "format": "int32", - "example": 1 - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "endTime": { - "type": "string", - "description": "End time.", - "example": "11:11:11" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Timeband:2HoursValidPlus1" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "TimeBand" - }, - "startTime": { - "type": "string", - "description": "Start time.", - "example": "11:11:11" - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "timeZone": { - "type": "string", - "description": "Time zone.", - "example": "Europe/Oslo", - "default": "Europe/Oslo" - }, - "validityConditions": { - "type": "array", - "description": "ValidityConditions sequence.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "The TimeBand describe during which the assignment applies" - }, - "Transferability": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "canTransfer": { - "type": "boolean", - "description": "Whether ticket can be transferred to someone else.", - "example": false - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare tables.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "hasTransferFee": { - "type": "boolean", - "description": "Whether there is a charge for making a transfer.", - "example": false - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:Transferability:NoTransfer" - }, - "maximumNumberOfNamedUsers": { - "type": "integer", - "description": "Where a product can be used by a limited number of named users, maximum number of users allowed..", - "format": "int32" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "Transferability" - }, - "prices": { - "type": "array", - "description": "Prices in different currencies for the transferability rule.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Transferability version.", - "example": "NSB:Version:V1" - } - }, - "description": "Transferability" - }, - "TransferabilityAlternatives": { - "required": [ - "ref", - "transferabilityOptions" - ], - "type": "object", - "properties": { - "ref": { - "$ref": "#/components/schemas/IdAndVersion" - }, - "transferabilityOptions": { - "type": "array", - "description": "Transferability alternatives for this element.", - "items": { - "$ref": "#/components/schemas/Transferability" - } - } - }, - "description": "Transferability alternatives for an element." - }, - "TypeOfAccessRightAssignment": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "TypeOfAccessRightAssignment" - }, - "status": { - "type": "string", - "description": "Type of access right assignment status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Type of access right assignment version.", - "example": "NSB:Version:V1" - } - }, - "description": "A classification of Access Right Assignments." - }, - "TypeOfConcession": { - "required": [ - "changed", - "compatibleWithVersionRef", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "alternativeNames": { - "type": "string", - "description": "Alternative names for the type of concession" - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "TypeOfConcession description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TypeOfConcession:Student" - }, - "infolink": { - "type": "string", - "description": "An URL to more info about the type of concession" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "TypeOfConcession name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "TypeOfConcession" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "privateCode": { - "type": "string", - "description": "A code to support interoperability with legacy systems" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "TypeOfConcession version.", - "example": "NSB:Version:V1" - } - }, - "description": "A TypeOfConcession" - }, - "TypeOfConcessionInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "alternativeNames": { - "type": "string", - "description": "Alternative names for the type of concession" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "TypeOfConcession description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:TypeOfConcession:Student" - }, - "infolink": { - "type": "string", - "description": "An URL to more info about the type of concession" - }, - "name": { - "type": "array", - "description": "TypeOfConcession name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "privateCode": { - "type": "string", - "description": "A code to support interoperability with legacy systems" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "TypeOfConcession version.", - "example": "NSB:Version:V1" - } - }, - "description": "A TypeOfConcession" - }, - "TypeOfFareProduct": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "nameOfClass", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TypeOfFareProduct:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "TypeOfFareProduct" - }, - "status": { - "type": "string", - "description": "Type of fare product status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Type of fare product version.", - "example": "NSB:Version:V1" - } - }, - "description": "A classification of FARE PRODUCTs." - }, - "TypeOfFareProductInsert": { - "required": [ - "fareFrameRef", - "id" - ], - "type": "object", - "properties": { - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TypeOfFareProduct:Ordinary" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Type of fare product version.", - "example": "NSB:Version:V1" - } - } - }, - "TypeOfUsageParameter": { - "required": [ - "changed", - "compatibleWithVersionRef", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TypeOfUsageParameter:abc123" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "TypeOfUsageParameter" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "TypeOfUsageParameterInsert": { - "required": [ - "fareFrameRef", - "id", - "version" - ], - "type": "object", - "properties": { - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:TypeOfUsageParameter:ThroughFareInterchanging" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - } - }, - "UVPForNumberOfZones": { - "required": [ - "authorityId", - "fareFrameRef", - "id", - "nameOfClass", - "numberOfZones", - "status", - "usageValidityPeriodId", - "version" - ], - "type": "object", - "properties": { - "authorityId": { - "type": "string", - "description": "Reference to authority.", - "example": "RUT:Authority:RUT" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:UVPForNumberOfZones:example" - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "UVPForNumberOfZones" - }, - "numberOfZones": { - "type": "integer", - "description": "Number of zones.", - "format": "int64", - "example": 3 - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "usageValidityPeriodId": { - "type": "string", - "description": "Reference to usage validity period.", - "example": "NSB:UsageValidityPeriod:Child" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - }, - "zoneRange": { - "type": "string", - "description": "Zone range.", - "example": "4:9" - } - } - }, - "UVPForNumberOfZonesInsert": { - "required": [ - "authorityId", - "fareFrameRef", - "id", - "numberOfZones", - "usageValidityPeriodId" - ], - "type": "object", - "properties": { - "authorityId": { - "type": "string", - "description": "Reference to authority.", - "example": "RUT:Authority:RUT" - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:UVPForNumberOFZones:123" - }, - "numberOfZones": { - "type": "integer", - "description": "Number of zones.", - "format": "int64", - "example": 3 - }, - "usageValidityPeriodId": { - "type": "string", - "description": "Reference to usage validity period.", - "example": "NSB:UsageValidityPeriod:Child" - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - }, - "zoneRange": { - "type": "string", - "description": "Zone range.", - "example": "4:9" - } - } - }, - "UsageValidityPeriod": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "activationMeans": { - "type": "array", - "description": "Activation Means. Describes how a product can be activated.", - "items": { - "type": "string" - } - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to FareTable.", - "items": { - "$ref": "#/components/schemas/FareTableRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:UsageValidityPeriod:Child" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/LimitingRule" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "UsageValidityPeriod" - }, - "standardDuration": { - "type": "string", - "description": "Standard duration. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "steppedDuration": { - "$ref": "#/components/schemas/SteppedDuration" - }, - "usageEnd": { - "type": "string", - "description": "Usage end.", - "enum": [ - "STANDARD_DURATION", - "END_OF_CALENDAR_PERIOD", - "END_OF_RIDE", - "END_OF_TRIP", - "END_OF_FARE_DAY", - "END_OF_FARE_PERIOD", - "PRODUCT_EXPIRY", - "PROFILE_EXPIRY", - "DEREGISTRATION", - "UOTHER" - ] - }, - "usageEnds": { - "type": "array", - "description": "Usage ends. This field is deprecated, please use the field usageEnd", - "deprecated": true, - "items": { - "type": "string" - } - }, - "usageStartConstraintType": { - "type": "string", - "description": "Usage start constraint.", - "enum": [ - "VARIABLE", - "FIXED", - "FIXED_WINDOW" - ] - }, - "usageTrigger": { - "type": "string", - "description": "Usage trigger.", - "enum": [ - "START_OF_PERIOD", - "START_OUT_BOUND_RIDE", - "END_OUT_BOUND_RIDE", - "START_RETURN_RIDE", - "PURCHASE", - "SPECIFIED_START_DATE", - "FULFILMENT", - "DAY_OFFSET_BEFORE_CALENDAR_PERIOD" - ] - }, - "usageValidityType": { - "type": "string", - "description": "Usage validity type.", - "enum": [ - "SINGLE_RIDE", - "SINGLE_TRIP", - "RETURN_TRIP", - "CARNET", - "DAY_PASS", - "WEEKLY_PASS", - "WEEKEND_PASS", - "MONTHLY_PASS", - "SEASON_TICKET", - "PROFILE_MEMBERSHIP", - "OPEN_ENDED", - "OTHER" - ] - }, - "usageValidityTypes": { - "type": "array", - "description": "Usage validity type list.", - "items": { - "type": "string" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UsageValidityPeriod version.", - "example": "NSB:Version:V1" - } - }, - "description": "A UsageValidityPeriod response" - }, - "UsageValidityPeriodInsert": { - "required": [ - "fareFrameRef", - "fareTableRefs", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "activationMeans": { - "type": "array", - "description": "Activation Means. Describes how a product can be activated.", - "items": { - "type": "string" - } - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to FareTable.", - "items": { - "$ref": "#/components/schemas/FareTableRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:UsageValidityPeriod:30Days" - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "standardDuration": { - "type": "string", - "description": "Standard duration. Represented as a string formatted according to ISO-8601", - "example": "PT1H" - }, - "steppedDuration": { - "$ref": "#/components/schemas/SteppedDuration" - }, - "usageEnd": { - "type": "string", - "description": "Usage end.", - "enum": [ - "STANDARD_DURATION", - "END_OF_CALENDAR_PERIOD", - "END_OF_RIDE", - "END_OF_TRIP", - "END_OF_FARE_DAY", - "END_OF_FARE_PERIOD", - "PRODUCT_EXPIRY", - "PROFILE_EXPIRY", - "UOTHER" - ] - }, - "usageEnds": { - "type": "array", - "description": "Usage End list.", - "items": { - "type": "string" - } - }, - "usageStartConstraintType": { - "type": "string", - "description": "Usage start constraint.", - "enum": [ - "VARIABLE", - "FIXED", - "FIXED_WINDOW" - ] - }, - "usageTrigger": { - "type": "string", - "description": "Usage trigger.", - "enum": [ - "START_OF_PERIOD", - "START_OUT_BOUND_RIDE", - "END_OUT_BOUND_RIDE", - "START_RETURN_RIDE", - "PURCHASE", - "SPECIFIED_START_DATE", - "FULFILMENT", - "DAY_OFFSET_BEFORE_CALENDAR_PERIOD" - ] - }, - "usageValidityTypes": { - "type": "array", - "description": "Usage validity type list.", - "items": { - "type": "string" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UsageValidityPeriod version.", - "example": "NSB:Version:V1" - } - } - }, - "UserProfile": { - "required": [ - "changed", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "baseUserProfileRef": { - "type": "string", - "description": "The id of the base user profile which this profile is a specialization of." - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "format": "date-time" - }, - "companionProfiles": { - "type": "array", - "description": "Companion Profiles in Group Ticket", - "items": { - "$ref": "#/components/schemas/CompanionProfile" - } - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "format": "date-time" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the user profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:UserProfile:Child" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "maxAge": { - "type": "string", - "description": "Maximum age.", - "example": "16" - }, - "minAge": { - "type": "string", - "description": "Minimum age.", - "example": "4" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "UserProfile" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile", - "readOnly": true - }, - "prices": { - "type": "array", - "description": "Fare prices for the user profile.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "proofOfIdentity": { - "type": "string", - "description": "proofOfIdentity.", - "enum": [ - "NONE_REQUIRED", - "PASSPORT", - "DRIVERS_LICENCE", - "IDENTITY_DOCUMENT", - "CREDIT_CARD", - "MEMBERSHIP_CARD", - "STUDENT_CARD", - "LETTER_WITH_ADDRESS", - "MEDICAL_DOCUMENT", - "MEASUREMENT", - "OTHER" - ] - }, - "status": { - "type": "string", - "description": "Status", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "typeOfConcessionRef": { - "type": "string", - "description": "typeOfConcessionRef." - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "userType": { - "type": "string", - "description": "UserType.", - "example": "CHILD", - "enum": [ - "ANYONE", - "ADULT", - "CHILD", - "INFANT", - "ANIMAL", - "SENIOR", - "GUIDE_DOG", - "YOUTH", - "STUDENT", - "MILITARY" - ] - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UserProfile version.", - "example": "NSB:Version:V1" - } - }, - "description": "A UserProfile" - }, - "UserProfileInsert": { - "required": [ - "fareFrameRef", - "id", - "name", - "proofOfIdentity", - "version" - ], - "type": "object", - "properties": { - "baseUserProfileRef": { - "type": "string", - "description": "The id of the base user profile which this profile is a specialization of." - }, - "companionProfileIds": { - "type": "array", - "description": "Companion profiles describing users who may travel with user.", - "deprecated": true, - "items": { - "type": "string" - } - }, - "companionProfiles": { - "type": "array", - "description": "Companion profiles describing users who may travel with user.", - "items": { - "$ref": "#/components/schemas/CompanionProfileInject" - } - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version.", - "example": "NSB:Version:V1" - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version.", - "example": "NSB:Version:V1" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the user profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:UserProfile:Child" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "maxAge": { - "type": "integer", - "description": "Maximum age.", - "format": "int32", - "example": 16 - }, - "minAge": { - "type": "integer", - "description": "Minimum age.", - "format": "int32", - "example": 4 - }, - "name": { - "type": "array", - "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices for the user profile.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "proofOfIdentity": { - "type": "string", - "description": "proofOfIdentity.", - "enum": [ - "NONE_REQUIRED", - "PASSPORT", - "DRIVERS_LICENCE", - "IDENTITY_DOCUMENT", - "CREDIT_CARD", - "MEMBERSHIP_CARD", - "STUDENT_CARD", - "LETTER_WITH_ADDRESS", - "MEDICAL_DOCUMENT", - "MEASUREMENT", - "OTHER" - ] - }, - "typeOfConcessionRef": { - "type": "string", - "description": "typeOfConcessionRef." - }, - "typeOfUsageParameter": { - "type": "string", - "description": "typeOfUsageParameter." - }, - "userType": { - "type": "string", - "description": "UserType.", - "example": "CHILD", - "enum": [ - "ANYONE", - "ADULT", - "CHILD", - "INFANT", - "ANIMAL", - "SENIOR", - "GUIDE_DOG", - "YOUTH", - "STUDENT", - "MILITARY" - ] - }, - "validityConditions": { - "type": "array", - "description": "Validity conditions for the user profile.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "UserProfile version.", - "example": "NSB:Version:V1" - } - }, - "description": "A UserProfile create request" - }, - "ValidBetween": { - "required": [ - "changed", - "created", - "fareFrameRef", - "fromDate", - "id", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description of ValidBetween represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fromDate": { - "type": "string", - "description": "From Date." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ValidBetween:2018" - }, - "name": { - "type": "array", - "description": "Name of ValidBetween represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "ValidBetween" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "toDate": { - "type": "string", - "description": "To Date." - }, - "validityConditions": { - "type": "array", - "description": "List of validityConditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A ValidBetween" - }, - "ValidBetweenInsert": { - "required": [ - "fareFrameRef", - "fromDate", - "id" - ], - "type": "object", - "properties": { - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fromDate": { - "type": "string", - "description": "From Date.", - "example": "2017-07-21T17:32:28Z" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ValidBetween:2018" - }, - "toDate": { - "type": "string", - "description": "To Date.", - "example": "2017-07-21T17:32:28Z" - }, - "validityConditions": { - "type": "array", - "description": "List of validityConditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A ValidBetween create request" - }, - "ValidableElement": { - "required": [ - "accessRightParameterAssignments", - "changed", - "created", - "fareFrameRef", - "fareTableRefs", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "The references to access right parameter assignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "areaValidity": { - "$ref": "#/components/schemas/AreaValidity" - }, - "changed": { - "type": "string", - "description": "Changed datetime." - }, - "compatibleWithVersionRef": { - "type": "string", - "description": "Compatible with version." - }, - "created": { - "type": "string", - "description": "Created datetime." - }, - "derivedFromVersionRef": { - "type": "string", - "description": "Derived from version." - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementsInSequence": { - "type": "array", - "description": "The fare structure elements in sequence", - "items": { - "$ref": "#/components/schemas/FareStructureElementInSequence" - } - }, - "fareStructureElementsRef": { - "type": "array", - "description": "The reference to the fare divided into a sequence.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "fareTableRefs": { - "type": "array", - "description": "References for associated fare table.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ValidableElement:Ordinary" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "example": "ValidableElement" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "pricingRuleRef": { - "type": "string", - "description": "Pricing rule reference.", - "example": "unused" - }, - "status": { - "type": "string", - "description": "Status.", - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityConditions": { - "type": "array", - "description": "Gives a sequence of conditions for validity.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Validable element version.", - "example": "NSB:Version:V1" - } - }, - "description": "A ValidationElement" - }, - "ValidableElementInsert": { - "required": [ - "description", - "fareFrameRef", - "id", - "name", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "The references to access right parameter assignments.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "areaValidity": { - "$ref": "#/components/schemas/AreaValidity" - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureElementsInSequence": { - "type": "array", - "description": "Fare structure elements in sequence", - "items": { - "$ref": "#/components/schemas/FareStructureElementInSequenceInsert" - } - }, - "fareStructureElementsRef": { - "type": "array", - "description": "The reference to the fare divided into a sequence.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "fareTableRefs": { - "type": "array", - "description": "References to fare tables that provide prices or discounts for the user profile.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:ValidableElement:Child" - }, - "name": { - "type": "array", - "description": "ValidableElement Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePriceInsert" - } - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "ValidableElement version.", - "example": "NSB:Version:V1" - } - } - }, - "ValidableElementPageWrapper": { - "required": [ - "items", - "requestedPageNumber", - "totalNumberOfItems", - "totalNumberOfPages" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "Validable elements for the given page", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ValidableElement" - } - }, - "requestedPageNumber": { - "type": "integer", - "description": "Number of the requested page. In case state is lost", - "format": "int32", - "example": 1 - }, - "totalNumberOfItems": { - "type": "integer", - "description": "Total number of items.", - "format": "int32", - "example": 369 - }, - "totalNumberOfPages": { - "type": "integer", - "description": "Number of pages needed to traverse all items.", - "format": "int32", - "readOnly": true, - "example": 15 - } - }, - "description": "Validable Element Page Wrapper" - }, - "ValidityCondition": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "version" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "fromDate": { - "type": "string", - "description": "From Date." - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:ValidBetween:2018" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "ValidBetween" - }, - "status": { - "type": "string", - "description": "Status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "toDate": { - "type": "string", - "description": "To Date." - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version.", - "example": "NSB:Version:V1" - } - }, - "description": "A condition of the validity of the priceable object" - }, - "VatRegister": { - "required": [ - "description", - "id", - "validFrom", - "vatGroup", - "vatRate" - ], - "type": "object", - "properties": { - "arrivalCountryCode": { - "type": "string", - "description": "Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3", - "example": "NOR" - }, - "countryCode": { - "type": "string", - "description": "Country for which the VAT is valid, based on ISO 3166-1 alfa-3", - "example": "NOR" - }, - "departureCountryCode": { - "type": "string", - "description": "Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3", - "example": "NOR" - }, - "description": { - "minLength": 1, - "type": "string", - "description": "The VAT description", - "example": "Person transport and tickets in Norway" - }, - "id": { - "minLength": 1, - "type": "string", - "description": "Id.", - "example": "ENT:VatRegister:SomeId" - }, - "organisationId": { - "type": "integer", - "description": "OrganisationId for the organisation who uses this VAT-specification.", - "format": "int64" - }, - "validFrom": { - "minLength": 1, - "type": "string", - "description": "The time and date from which the VAT is valid" - }, - "validTo": { - "type": "string", - "description": "The time and date to which the VAT is valid" - }, - "vatCode": { - "type": "string", - "description": "Code for the VAT, used for accounting", - "example": "33" - }, - "vatGroup": { - "type": "string", - "description": "VAT group", - "example": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "vatRate": { - "minLength": 1, - "type": "string", - "description": "The percentage rate for the VAT", - "example": "12.0" - } - }, - "description": "A case class for vat register." - }, - "Version": { - "required": [ - "changed", - "created", - "id", - "modification", - "nameOfClass", - "status", - "versionType" - ], - "type": "object", - "properties": { - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description." - }, - "endDate": { - "type": "string", - "description": "EndDate", - "format": "date-time" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "RUT:Version:RuterSingleTicket" - }, - "modification": { - "type": "string", - "description": "Modification status", - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "Version" - }, - "startDate": { - "type": "string", - "description": "StartDate", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "default": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "versionType": { - "type": "string", - "description": "VersionType.", - "enum": [ - "BASELINE", - "POINT" - ] - } - }, - "description": "A case class for versioning." - }, - "VersionBatchRetrieve": { - "required": [ - "entityIds" - ], - "type": "object", - "properties": { - "entityIds": { - "type": "array", - "description": "entityIds", - "example": [ - "ENT:PreassignedFareProduct:abc123", - "ENT:PreassignedFareProduct:123abc" - ], - "items": { - "type": "string" - } - } - }, - "description": "A case class for versioning." - }, - "VersionOfObjectRef": { - "required": [ - "nameOfClass", - "ref", - "version" - ], - "type": "object", - "properties": { - "nameOfClass": { - "minLength": 1, - "type": "string", - "description": "Name of class." - }, - "ref": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "The netex id reference to the object." - }, - "version": { - "type": "string", - "description": "Version." - } - }, - "description": "Fare frame ref." - }, - "v2.DistributionAssignment": { - "required": [ - "allDistributionChannelsRef", - "changed", - "created", - "distributionRights", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "organisationRef", - "paymentMethods", - "salesPackageRef", - "status", - "version" - ], - "type": "object", - "properties": { - "allDistributionChannelsRef": { - "type": "boolean", - "description": "Flag for distribution in all channels." - }, - "allOrganisationRef": { - "type": "boolean", - "description": "Flag for all organisations." - }, - "allowedInChannel": { - "type": "boolean", - "description": "Flag for allowed in channel." - }, - "allowedInCountry": { - "type": "boolean", - "description": "Flag for allowed in country." - }, - "anyCountryRef": { - "type": "boolean", - "description": "Flag for allowed in any country." - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "countryRef": { - "type": "string", - "description": "Country reference." - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionChannelRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "distributionChannelType": { - "type": "string", - "description": "Type of distribution channel.", - "enum": [ - "AT_STOP", - "ON_BOARD", - "ONLINE", - "TELEPHONE", - "ELECTRONIC_PASS", - "MOBILE_DEVICE", - "AGENCY", - "TOUR_OPERATOR", - "OTHER" - ] - }, - "distributionRights": { - "type": "string", - "description": "Distribution rights.", - "example": "SELL", - "enum": [ - "NONE", - "SELL", - "REFUND", - "EXCHANGE", - "INFROM", - "PRIVATE", - "OTHER" - ] - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "finalCarrier": { - "type": "boolean", - "description": "Flag for final carrier." - }, - "fulfilmentMethodRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfDistributionChannelsRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "groupOfSalesPackagesRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:DistributionAssignment:Ordinary" - }, - "initialCarrier": { - "type": "boolean", - "description": "Flag for initial carrier." - }, - "mandatoryProduct": { - "type": "boolean", - "description": "Flag for mandatory product." - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "The name of the distribution assignment represented in different languages. Language codes are ISO-639", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "DistributionAssignment" - }, - "organisationRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "paymentMethods": { - "type": "array", - "description": "Payment methods.", - "items": { - "type": "string", - "example": "CREDIT_CARD", - "enum": [ - "CASH", - "CASH_AND_CARD", - "COIN", - "BANKNOTE", - "CREDIT_CARD", - "DEBIT_CARD", - "CONTACTLESS_PAYMENT_CARD", - "CARDS_ONLY", - "TRAVEL_CARD", - "CONTACTLESS_TRAVEL_CARD", - "SMS", - "MOBILE_PHONE", - "CHEQUE", - "COMPANY_CHEQUE", - "TRAVELLERS_CHEQUE", - "POSTAL_ORDER", - "VOUCHER", - "TOKEN", - "WARRANT", - "OTHER" - ] - } - }, - "requiresRegistration": { - "type": "boolean", - "description": "Flag for requires registration." - }, - "responsibilitySetRef": { - "type": "string", - "description": "Responsibility set reference." - }, - "restrictedToChannel": { - "type": "boolean", - "description": "Flag for restricted to channel." - }, - "salesPackageRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "serviceAccessRightRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "ticketingServices": { - "type": "array", - "description": "Ticketing services.", - "items": { - "type": "string", - "enum": [ - "TSF_PURCHASE", - "COLLECTION", - "CARD_TOP_UP", - "RESERVATIONS" - ] - } - }, - "topographicPlaceRef": { - "type": "string", - "description": "Topographical place reference." - }, - "transitCarrier": { - "type": "boolean", - "description": "Flag for transit carrier." - }, - "version": { - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - } - }, - "v2.SalesPackage": { - "required": [ - "changed", - "created", - "distributionAssignments", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "status", - "validityParameterAssignments", - "version" - ], - "type": "object", - "properties": { - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active for this SP.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "Changed datetime", - "readOnly": true - }, - "created": { - "type": "string", - "description": "Created datetime", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "distributionAssignments": { - "type": "array", - "description": "Distribution assignments.", - "items": { - "$ref": "#/components/schemas/v2.DistributionAssignment" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id", - "example": "NSB:SalesPackage:Ordinary" - }, - "limitingRule": { - "$ref": "#/components/schemas/LimitingRule" - }, - "limitingRuleRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "modification": { - "type": "string", - "description": "Modification status", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class", - "readOnly": true, - "example": "SalesPackage" - }, - "organisationId": { - "type": "string", - "description": "Organisation related to the userProfile" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "salesPackageElements": { - "type": "array", - "description": "Sales package elements.", - "items": { - "$ref": "#/components/schemas/SalesPackageElement" - } - }, - "status": { - "type": "string", - "description": "Status", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "validityParameterAssignments": { - "type": "array", - "description": "Validity Parameter assignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "vatGroupRegister": { - "type": "string", - "description": "VatGroupRegister is optional. No default value", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Version", - "example": "NSB:Version:V1" - } - }, - "description": "SalesPackage" - }, - "v2.SupplementProduct": { - "required": [ - "changed", - "chargingMomentRef", - "created", - "fareFrameRef", - "id", - "modification", - "nameOfClass", - "operatorRef", - "organisationRef", - "status", - "version" - ], - "type": "object", - "properties": { - "accessRightParameterAssignments": { - "type": "array", - "description": "accessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/GenericParameterAssignment" - } - }, - "accessRightsInProduct": { - "type": "array", - "description": "accessRightParameterAssignments.", - "items": { - "$ref": "#/components/schemas/AccessRightInProduct" - } - }, - "activeComparisonOperatorVariant": { - "type": "string", - "description": "Indicates whether A or E gpa implementation is active.", - "example": "A" - }, - "changed": { - "type": "string", - "description": "Changed datetime.", - "readOnly": true - }, - "chargingMomentRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "chargingMomentType": { - "type": "string", - "description": "ChargingMomentType.", - "example": "BEFORE_TRAVEL", - "enum": [ - "BEFORE_TRAVEL", - "ON_START_OF_TRAVEL", - "BEFORE_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_TRAVEL", - "ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY", - "ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD", - "AT_END_OF_TRAVEL", - "AT_END_OF_CHARGE_PERIOD", - "FREE", - "ANY_TIME", - "OTHER" - ] - }, - "conditionSummary": { - "$ref": "#/components/schemas/ConditionSummary" - }, - "created": { - "type": "string", - "description": "Created datetime.", - "readOnly": true - }, - "description": { - "type": "array", - "description": "Description represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "fareFrameRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "fareStructureType": { - "type": "string", - "description": "FareStructureType", - "example": "POINT_TO_POINT_FARE", - "enum": [ - "CAPPED_FLAT_FARE", - "CAPPED_POINT_TO_POINT_FARE", - "CAPPED_ZONAL_FARE", - "LINE_FLAT_FARE", - "NETWORK_FLAT_FARE", - "POINT_TO_POINT_FARE", - "POINT_TO_POINT_DISTANCE_FARE", - "STAGE_FARE", - "ZONE_FLAT_FARE", - "ZONE_SEQUENCE_FARE", - "ZONE_TO_ZONE_FARE", - "ZONE_COUNT_FARE", - "PENALTY_FARE", - "OTHER" - ] - }, - "fareTableRefs": { - "type": "array", - "description": "Reference to information about the fare.", - "items": { - "$ref": "#/components/schemas/VersionOfObjectRef" - } - }, - "id": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Id.", - "example": "NSB:SupplementProduct:BicycleReserving" - }, - "modification": { - "type": "string", - "description": "Modification status.", - "readOnly": true, - "example": "NEW", - "enum": [ - "NEW", - "REVISE", - "DELETE" - ] - }, - "name": { - "type": "array", - "description": "Name represented in different languages. Language codes are ISO-639.", - "items": { - "$ref": "#/components/schemas/TextInLanguage" - } - }, - "nameOfClass": { - "type": "string", - "description": "Name of class.", - "readOnly": true, - "example": "SupplementProduct" - }, - "operatorRef": { - "type": "string", - "description": "The reference to the operator.", - "example": "RUT:Authority:RUT" - }, - "organisationRef": { - "type": "string", - "description": "The reference to the organisation.", - "example": "ENT:Authority:ENT" - }, - "prices": { - "type": "array", - "description": "Fare prices.", - "items": { - "$ref": "#/components/schemas/FarePrice" - } - }, - "privateCode": { - "type": "string", - "description": "Privat code." - }, - "status": { - "type": "string", - "description": "Supplement product status.", - "readOnly": true, - "example": "DRAFT", - "enum": [ - "DRAFT", - "PROPOSED", - "VERSIONED", - "DEPRECATED" - ] - }, - "supplementProductType": { - "type": "string", - "description": "The type of supplement product for which the supplement product belongs to.", - "enum": [ - "SEAT_RESERVATION", - "BICYCLE", - "DOG", - "ANIMAL", - "MEAL", - "WIFI", - "EXTRA_LUGGAGE", - "PENALTY", - "UPGRADE", - "JOURNEY_EXTENSION", - "JOURNEY_ADD_ON", - "EVENT_ADD_ON", - "PARKING", - "TOP_UP", - "OTHER" - ] - }, - "typeOfFareProductRef": { - "$ref": "#/components/schemas/VersionOfObjectRef" - }, - "validityConditions": { - "type": "array", - "description": "validityConditions.", - "items": { - "$ref": "#/components/schemas/ValidityCondition" - } - }, - "vatGroupRegister": { - "type": "string", - "description": "The VAT group for the SupplementProduct.", - "default": "TRANSPORT_AND_TICKETS_VAT", - "enum": [ - "EXCEPTION_FROM_VAT", - "GENERAL_VAT", - "FOOD_VAT", - "TRANSPORT_AND_TICKETS_VAT" - ] - }, - "version": { - "minLength": 1, - "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", - "type": "string", - "description": "Supplement product version.", - "example": "NSB:Version:V1" - } - }, - "description": "A Supplement product consisting of one or several validable elements, specific to a charging moment and fare product" - } - }, - "securitySchemes": { - "jwt": { - "bearerFormat": "JWT", - "scheme": "bearer", - "type": "http" - } - } - } -} \ No newline at end of file