{ "openapi": "3.1.1", "info": { "title": "Products", "description": "This API provides services to read and maintain products and fare data for public transport in Norway.", "version": "2026.06.4" }, "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": [ { "name": "supplement-products", "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" } ], "paths": { "/tariffs": { "post": { "tags": [ "tariffs" ], "summary": "Create a tariff", "operationId": "tariffs_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TariffInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/versions": { "post": { "tags": [ "versions" ], "summary": "Create version", "operationId": "versions_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/day-types": { "get": { "tags": [ "day-types" ], "summary": "Retrieves all day types", "operationId": "day-types_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DayType" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "day-types" ], "summary": "Create a dayType", "operationId": "day-types_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DayType" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/meta-data": { "post": { "tags": [ "meta-data" ], "summary": "Create metadata", "operationId": "meta-data_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Metadata" } } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding": { "get": { "tags": [ "refunding" ], "summary": "Retrieves all refundings", "operationId": "refunding_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refunding" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "refunding" ], "summary": "Create a refunding rules", "operationId": "refunding_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/replacing": { "get": { "tags": [ "replacing" ], "summary": "Retrieves all replacings", "operationId": "replacing_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Replacing" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "replacing" ], "summary": "Create a Replacing", "operationId": "replacing_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Replacing" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/reserving": { "get": { "tags": [ "reserving" ], "summary": "Retrieves all reserving rules", "operationId": "reserving_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reserving" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "reserving" ], "summary": "Create a reserving rule", "operationId": "reserving_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/reverting": { "get": { "tags": [ "reverting" ], "summary": "Retrieves all reverting parameters", "operationId": "reverting_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reverting" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "reverting" ], "summary": "Create a Reverting", "operationId": "reverting_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reverting" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/roundings": { "get": { "tags": [ "roundings" ], "summary": "Retrieves all rounding parameters", "operationId": "roundings_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rounding" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "roundings" ], "summary": "Create a rounding", "operationId": "roundings_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rounding" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/timebands": { "get": { "tags": [ "timebands" ], "summary": "Retrieves all time bands", "operationId": "timebands_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Timeband" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "timebands" ], "summary": "Create a time band", "operationId": "timebands_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timeband" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging": { "get": { "tags": [ "exchanging" ], "summary": "Retrieves all exchanging rules", "operationId": "exchanging_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Languagecode", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "exchanging" ], "summary": "Create an exchanging rule", "operationId": "exchanging_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-frames": { "get": { "tags": [ "fare-frames" ], "summary": "Retrieves fare frames by organisation id", "operationId": "fare-frames_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareFrame" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves all faretables. Limiting selection by fareFrameId parameter is supported", "operationId": "fare-tables_findByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "if set to true fare table cells will be omitted", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareTable" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fare-tables" ], "summary": "Create a fare table", "operationId": "fare-tables_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareTableInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/round-trips": { "get": { "tags": [ "round-trips" ], "summary": "Retrieves all round trips", "operationId": "round-trips_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info" }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "round-trips" ], "summary": "Create a roundtrip", "operationId": "round-trips_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundTripInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/vat-register": { "get": { "tags": [ "vat-register" ], "summary": "Retrieves all vat registers", "operationId": "vat-register_getAllVatRegisters", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatRegister" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-products": { "get": { "tags": [ "fare-products" ], "summary": "Retrieves all fare-products, filtered by given parameter(s)", "operationId": "fare-products_findByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "typeOfFareProductId", "in": "query", "description": "The unique id to identify the type of fare product", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-sections": { "get": { "tags": [ "fare-sections" ], "summary": "Retrieves all fare sections", "operationId": "fare-sections_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareSection" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fare-sections" ], "summary": "Create a fareSection", "operationId": "fare-sections_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareSection" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/group-tickets": { "get": { "tags": [ "group-tickets" ], "summary": "Retrieves all group tickets accessible by user rights", "operationId": "group-tickets_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all group tickets", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupTicket" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "group-tickets" ], "summary": "Create a group ticket", "operationId": "group-tickets_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupTicketInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/user-profiles": { "get": { "tags": [ "user-profiles" ], "summary": "Retrieves all user profile", "operationId": "user-profiles_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "validOnDate", "in": "query", "description": "Return the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfile" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "user-profiles" ], "summary": "Create a userprofile", "operationId": "user-profiles_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/versions/{id}": { "get": { "tags": [ "versions" ], "summary": "Get version for netexid", "operationId": "versions_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex id to identify a version entry", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "versions" ], "summary": "Set the status of a product version by id", "operationId": "versions_updateVersionStatus", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a version of a product", "required": true, "style": "simple", "explode": false, "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": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-day-types": { "get": { "tags": [ "fare-day-types" ], "summary": "Retrieves all fare day types", "operationId": "fare-day-types_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareDayType" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fare-day-types" ], "summary": "Create a fare day Type", "operationId": "fare-day-types_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareDayType" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/interchangings": { "get": { "tags": [ "interchangings" ], "summary": "Retrieves all interchangings for a given fare frame", "operationId": "interchangings_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset for an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Interchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "interchangings" ], "summary": "Create an interchanging", "operationId": "interchangings_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterchangingInsert" } } }, "required": true }, "responses": { "204": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/period-tickets": { "get": { "tags": [ "period-tickets" ], "summary": "Retrieves a period tickets and its userprofiles and usage validity periods by authority", "operationId": "period-tickets_findPeriodTicketsByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodTicketInfo" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding/{id}": { "get": { "tags": [ "refunding" ], "summary": "Retrieves a refunding rule by id", "operationId": "refunding_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the refunding", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refunding" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/reserving/{id}": { "get": { "tags": [ "reserving" ], "summary": "Retrieves a reserving rule by ID.", "operationId": "reserving_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID to identify a reserving.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The ID for the version of the reservation.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the reserving.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reserving" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sales-packages": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves sales packages by organisation id", "operationId": "sales-packages_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPackage" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "sales-packages" ], "summary": "Create a salespackage", "operationId": "sales-packages_create_1", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPackageInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/valid-betweens": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrieves all valid betweens for a given fare frame. This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset for an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicyAlternatives" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "valid-betweens" ], "summary": "Create a validBetween. This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetweenInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/versions/batch": { "post": { "tags": [ "versions" ], "summary": "Get all versions", "operationId": "versions_getVersionsByObjectIds", "parameters": [ { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionBatchRetrieve" } } }, "required": true }, "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Version" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging/{id}": { "get": { "tags": [ "exchanging" ], "summary": "Retrieves an exchanging rule by id", "operationId": "exchanging_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify an exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the purchase window", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchanging" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/security-policy": { "get": { "tags": [ "security-policy" ], "summary": "Retrieves all security policies", "operationId": "security-policy_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "security-policy" ], "summary": "Create a SecurityPolicy", "operationId": "security-policy_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityPolicy" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/tariffs/{id}": { "get": { "tags": [ "tariffs" ], "summary": "Retrives a tariff by id", "operationId": "tariffs_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a tariff", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the tariff", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the tariffs version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the tariffs version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tariff" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/charging-moments": { "post": { "tags": [ "charging-moments" ], "summary": "Create a charging moment controller", "operationId": "charging-moments_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargingMomentInsert" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-frames/{id}": { "get": { "tags": [ "fare-frames" ], "summary": "Retrives a fareFrames by id", "operationId": "fare-frames_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fareFrames", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the fareFrames", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareFrame" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/{id}": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves a fare table by id", "description": "Note! Only fare tables with active versions will be fetched", "operationId": "fare-tables_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare table", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the fare table", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "if set to true fare table cells will be omitted", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the fare table", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareTable" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/journey-patterns": { "get": { "tags": [ "journey-patterns" ], "summary": "Retrieves all journey patterns", "operationId": "journey-patterns_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JourneyPattern" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "journey-patterns" ], "summary": "Create a JourneyPattern", "operationId": "journey-patterns_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyPattern" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policies": { "get": { "tags": [ "penalty Policy" ], "summary": "Retrieves all penaltyPolicy parameters", "operationId": "penalty Policy_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "penalty Policy" ], "operationId": "penalty Policy_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PenaltyPolicy" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/purchase-windows": { "get": { "tags": [ "purchase-windows" ], "summary": "Retrieves purchase window by fareFrame id or organisation id", "operationId": "purchase-windows_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique organisation id to identify the owner of the data", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique fareFrame id to identify the owner of the data", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseWindow" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "purchase-windows" ], "summary": "Create a purchase window", "operationId": "purchase-windows_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseWindowInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/round-trips/{id}": { "get": { "tags": [ "round-trips" ], "summary": "Retrives a roundtrip by id", "operationId": "round-trips_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a roundtrip", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the roundtrip", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundTrip" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/charging-policies": { "get": { "tags": [ "charging-policies" ], "summary": "Retrieves all charging policies", "operationId": "charging-policies_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargingPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/entitlement-given": { "get": { "tags": [ "entitlement-given" ], "summary": "Retrieves all entitlement given", "operationId": "entitlement-given_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementGiven" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "entitlement-given" ], "summary": "Create a EntitlementGiven", "operationId": "entitlement-given_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementGiven" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/count": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves the number of fareTables. Limiting selection by fareFrameId and orgId parameter is supported", "operationId": "fare-tables_getFareTableCount", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returs the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/pages": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves fareTables for a given page. Limiting selection by fareFrameId and orgId parameter is supported", "operationId": "fare-tables_findPageByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Size of page", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Page number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "minimizeDataLoad", "in": "query", "description": "if set to true fare table cells will be omitted", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareTablePageWrapper" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferabilities": { "get": { "tags": [ "transferabilities" ], "summary": "Retrieves all transferabilities", "operationId": "transferabilities_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transferability" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "transferabilities" ], "summary": "Create a transferability", "operationId": "transferabilities_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transferability" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/refunding/{id}": { "get": { "tags": [ "refunding" ], "summary": "Retrieves a refunding rule by id", "operationId": "refunding_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the refunding rule", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the refunding rules version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the refunding rules version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refunding" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/reserving/{id}": { "get": { "tags": [ "reserving" ], "summary": "Retrieves a reserving rule by ID", "operationId": "reserving_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID to identify a reserving.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the reserving rule.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the reserving rule version.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the reserving rule version.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the reserving rule.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reserving" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/sales-packages": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves all sales packages", "operationId": "sales-packages_getAllWithGpaDataSetAndStatusFilter", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2.SalesPackage" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "sales-packages" ], "summary": "Create a sales package", "operationId": "sales-packages_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SalesPackage" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/valid-betweens": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrieves all valid betweens", "operationId": "valid-betweens_getAll_1", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValidBetween" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "valid-betweens" ], "summary": "Create a validBetween", "operationId": "valid-betweens_create_1", "parameters": [ { "name": "X-Correlated-Id", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetween" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/delete": { "put": { "tags": [ "admin/cache" ], "summary": "Delete all elements in cache or delete specific element given key in req.body", "operationId": "admin/cache_deleteEntityByObject", "parameters": [ { "name": "nameOfEntity", "in": "query", "description": "Specify this if you want to delete all elements connected to a specific type of entity. I.e. 'fare_structure_element' or 'fare_table' etc.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Successfully deleted", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "204": { "description": "No content. Deleted successfully", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/status": { "get": { "tags": [ "admin/cache" ], "summary": "Get cache statuses for all entities", "operationId": "admin/cache_getCacheStatuses", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved cache statuses", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MapStringObject" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/companion-profiles": { "get": { "tags": [ "companion-profiles" ], "summary": "Retrieves all companion profile", "operationId": "companion-profiles_findByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionProfile" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-quota-factors": { "get": { "tags": [ "fare-quota-factors" ], "summary": "Retrieves all fare quota factors given", "operationId": "fare-quota-factors_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareQuotaFactor" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fare-quota-factors" ], "summary": "Create a fareQuotaFactor", "operationId": "fare-quota-factors_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareQuotaFactor" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/frequencies-of-use": { "get": { "tags": [ "frequencies-of-use" ], "summary": "Retrieves all frequencies of use", "operationId": "frequencies-of-use_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the frequencies of use", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyOfUse" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "frequencies-of-use" ], "summary": "Create a frequency-of-use", "operationId": "frequencies-of-use_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrequencyOfUseInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fulfilment-methods": { "get": { "tags": [ "fulfilment-methods" ], "summary": "Retrieves all fulfilment methods", "operationId": "fulfilment-methods_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FulfilmentMethod" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fulfilment-methods" ], "summary": "Create a FulfilmentMethod", "operationId": "fulfilment-methods_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FulfilmentMethod" } } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/group-tickets/{id}": { "get": { "tags": [ "group-tickets" ], "summary": "Retrieves a group ticket by id", "operationId": "group-tickets_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the group ticket", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the group ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupTicket" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/luggage-allowances": { "get": { "tags": [ "luggage-allowances" ], "summary": "Retrieves all luggage allowances", "operationId": "luggage-allowances_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LuggageAllowance" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "luggage-allowances" ], "summary": "Create a luggage allowance", "operationId": "luggage-allowances_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LuggageAllowance" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-concession": { "get": { "tags": [ "type-of-concession" ], "summary": "Retrieves typeOfConcession by fareframe id or organisation id", "operationId": "type-of-concession_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fareframe", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOfConcession" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/user-profiles/{id}": { "get": { "tags": [ "user-profiles" ], "summary": "Retrieves a userprofile by id", "operationId": "user-profiles_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a userprofile", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the userprofile", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "validOnDate", "in": "query", "description": "Return the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that if this parameter is given, the version parameter is ignored.Also note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfile" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/exchanging/{id}": { "get": { "tags": [ "exchanging" ], "summary": "Retrieves a exchanging rule by id", "operationId": "exchanging_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the exchanging rule", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the exchanging rules version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the exchanging rules version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves validable elements by organisation id or fareframe", "operationId": "validable-elements_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resources", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValidableElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "validable-elements" ], "summary": "Create a validable-element", "operationId": "validable-elements_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidableElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/product-usages/{id}": { "get": { "tags": [ "product-usages" ], "summary": "Retrieves references whe the product with given id is referenced", "operationId": "product-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a parameter usage mapping ", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sales-packages/{id}": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves a sales package by id", "operationId": "sales-packages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPackage" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/supplement-products": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves a supplement products by organisation id", "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": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "the unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "supplement-products" ], "summary": "Create a SupplementProduct", "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": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/fare-frames/{id}": { "get": { "tags": [ "fare-frames" ], "summary": "Retrieves a fare frames by id", "operationId": "fare-frames_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare frames", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the fare frames version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the fare frames version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareFrame" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/fare-tables/{id}": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves a fare table by id", "operationId": "fare-tables_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare table", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the fare table", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "if set to true fare table cells will be omitted", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the fare tables version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the fare tables version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the fare table", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareTable" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/round-trips/{id}": { "get": { "tags": [ "round-trips" ], "summary": "Retrieves a round trips by id", "operationId": "round-trips_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a round trips", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the round trips", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the round trips version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the round tripss version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoundTrip" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/entitlement-products": { "get": { "tags": [ "entitlement-products" ], "summary": "Retrieves entitlement-products by organisation id and fare frame id", "operationId": "entitlement-products_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieves a preassignedFareProduct by organisation id", "operationId": "preassigned-products_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "language", "in": "query", "description": "the unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PreassignedFareProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "preassigned-products" ], "summary": "Create a PreassignedFareProduct", "operationId": "preassigned-products_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreassignedFareProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieves all sale discount rights", "operationId": "sale-discount-rights_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SaleDiscountRight" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "sale-discount-rights" ], "summary": "Create a SaleDiscountRight", "operationId": "sale-discount-rights_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaleDiscountRight" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/keys/info": { "get": { "tags": [ "admin/cache" ], "summary": "Get key info for entities in cache", "operationId": "admin/cache_getKeyInfo", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SetString" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/entitlements-required": { "get": { "tags": [ "entitlements-required" ], "summary": "Retrieves all entitlements required", "operationId": "entitlements-required_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementRequired" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "entitlements-required" ], "summary": "Create an EntitlementRequired", "operationId": "entitlements-required_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRequired" } } }, "required": true }, "responses": { "201": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/parameter-usages/{id}": { "get": { "tags": [ "parameter-usages" ], "summary": "Retrieves parameter usages for id", "operationId": "parameter-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a parameter usage mapping ", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/pricing-parameter-set": { "get": { "tags": [ "pricing-parameter-set" ], "summary": "Retrieves a pricing-parameter-set. Limiting selection by fareFrameId parameter is supported", "operationId": "pricing-parameter-set_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PricingParameterSet" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/purchase-windows/{id}": { "get": { "tags": [ "purchase-windows" ], "summary": "Retrives a purchase window by id", "operationId": "purchase-windows_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the purchase window", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseWindow" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/service-facility-sets": { "get": { "tags": [ "service-facility-sets" ], "summary": "Retrieves all service facility sets", "operationId": "service-facility-sets_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceFacilitySet" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "service-facility-sets" ], "summary": "Create a ServiceFacilitySet", "operationId": "service-facility-sets_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFacilitySet" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-fare-products": { "get": { "tags": [ "type-of-fare-products" ], "summary": "Retrieves type of fare products by organisationId or fareFrameId", "operationId": "type-of-fare-products_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfFareProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "type-of-fare-products" ], "summary": "Create type of fare product", "operationId": "type-of-fare-products_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfFareProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/group-tickets/{id}": { "get": { "tags": [ "group-tickets" ], "summary": "Retrieves a group ticket by id", "operationId": "group-tickets_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the group ticket", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the group tickets version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the group tickets version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the group ticket", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupTicket" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/user-profiles/{id}": { "get": { "tags": [ "user-profiles" ], "summary": "Retrieves a user profile by id", "operationId": "user-profiles_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a user profile", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the user profile", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "validOnDate", "in": "query", "description": "Return the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that if this parameter is given, the other parameters startDate, endDate and status are ignored. Only one UserProfile will be returned.Also note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the user profiles version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the user profiles version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfile" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/delete/all": { "put": { "tags": [ "admin/cache" ], "summary": "Delete all elements in cache", "operationId": "admin/cache_deleteAllEntitiesFromCache", "parameters": [], "responses": { "200": { "description": "Successfully deleted", "content": { "*/*": { "schema": { "type": "string" } } } }, "204": { "description": "No content. Deleted successfully", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/invalidate": { "put": { "tags": [ "admin/cache" ], "summary": "Delete all elements in cache", "operationId": "admin/cache_invalidateCache", "parameters": [ { "name": "nameOfEntity", "in": "query", "description": "Specify this if you want to invalidate cache for elements connected to a specific type of entity. I.e. 'fare_structure_element' or 'fare_table' etc. . If no value given all cache will be invalidated", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "all", "in": "query", "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.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully deleted", "content": { "*/*": { "schema": { "type": "string" } } } }, "204": { "description": "No content. Deleted successfully", "content": { "*/*": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/keys/count": { "get": { "tags": [ "admin/cache" ], "summary": "Count the DB size of Redis", "operationId": "admin/cache_getCount", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/capped-discount-rights": { "get": { "tags": [ "capped-discount-rights" ], "summary": "Retrieves a capped discount right, filtered by given parameter(s)", "operationId": "capped-discount-rights_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "language", "in": "query", "description": "The unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CappedDiscountRight" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "capped-discount-rights" ], "summary": "Create a capped discount right", "operationId": "capped-discount-rights_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CappedDiscountRightInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-table-usages/{id}": { "get": { "tags": [ "fare-table-usages" ], "summary": "Retrieves references where the given fare table id is referenced", "operationId": "fare-table-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex_id to identify a fare table ", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-intervals": { "post": { "tags": [ "geographical-intervals" ], "summary": "Create a GeographicalInterval", "operationId": "geographical-intervals_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalIntervalInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/tariffs/{id}/{version}": { "get": { "tags": [ "tariffs" ], "summary": "Retrives a tariff by id", "operationId": "tariffs_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a tariff", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the tariff", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tariff" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/usage-validity-periods": { "get": { "tags": [ "usage-validity-periods" ], "summary": "Retrieves usage validity periods by organisation id", "operationId": "usage-validity-periods_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UsageValidityPeriod" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "usage-validity-periods" ], "summary": "Create a usage validity parameter", "operationId": "usage-validity-periods_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageValidityPeriodInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/interchangings/{id}": { "get": { "tags": [ "interchangings" ], "summary": "Retrieves an interchanging by id", "operationId": "interchangings_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the interchaning", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the interchaning version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the interchaning version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns interchaning", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Interchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/sales-packages/{id}": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves a sales package by id", "operationId": "sales-packages_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the sales package", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the sales packages version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the sales packages version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPackage" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/valid-betweens/{id}": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrives valid betweens by id for a given date. This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the validBetween", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the validBetween version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the validBetween version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the valid between", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValidBetween" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/supplement-products": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves all supplement products", "operationId": "supplement-products_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2.SupplementProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "supplement-products" ], "summary": "Creates a new supplement product", "operationId": "supplement-products_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SupplementProduct" } } }, "required": true }, "responses": { "201": { "description": "Returns the created supplement product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SupplementProduct" } } } }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/valid-betweens/{id}": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrieves active valid between for id", "operationId": "valid-betweens_getById_1", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetween" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/availability-conditions": { "get": { "tags": [ "availability-conditions" ], "summary": "Retrieves all availability condition parameters", "operationId": "availability-conditions_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityCondition" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "availability-conditions" ], "summary": "Create a Availability Condition", "operationId": "availability-conditions_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCondition" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves a preassignedFareProduct by organisation id", "operationId": "fare-structure-elements_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset for an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/SeqStatusFilterEnum" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareStructureElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "fare-structure-elements" ], "summary": "Create a Fare structure element", "operationId": "fare-structure-elements_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareStructureElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding-possibilities": { "post": { "tags": [ "refunding-possibilities" ], "summary": "Retrieves refunding rules for given elements", "operationId": "refunding-possibilities_getRefundingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterPossibilitiesRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundingAlternatives" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-concession/{id}": { "get": { "tags": [ "type-of-concession" ], "summary": "Retrives a typeOfConcession by id", "operationId": "type-of-concession_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a typeOfConcession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the typeOfConcession", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfConcession" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/uvp-for-number-of-zones": { "get": { "tags": [ "uvp-for-number-of-zones" ], "summary": "uvp-for-number-of-zones", "operationId": "uvp-for-number-of-zones_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UVPForNumberOfZones" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Create a uvpForNumberOfZones", "operationId": "uvp-for-number-of-zones_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/sales-packages/count": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves the number of sales packages", "operationId": "sales-packages_count", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the number of sales packages", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/sales-packages/pages": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves the number of pages of sales packages", "operationId": "sales-packages_pages", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of sales packages per page", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the number of pages of sales packages", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPackagePageWrapper" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements/{id}": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves validable elements by id and latest version", "operationId": "validable-elements_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the given validable element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidableElement" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/vat-register/{vatGroup}": { "get": { "tags": [ "vat-register" ], "summary": "Retrieves vat register for group", "operationId": "vat-register_getVatRegisters", "parameters": [ { "name": "vatGroup", "in": "path", "description": "The identifier for a VAT", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatRegister" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/day-types/{id}/{version}": { "get": { "tags": [ "day-types" ], "summary": "Retrieves day type for id and version", "operationId": "day-types_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a DayType", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the DayType", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DayType" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "day-types" ], "summary": "Updates an existing DayType", "operationId": "day-types_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a DayType", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the DayType", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DayType" } } }, "required": true }, "responses": { "200": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "day-types" ], "summary": "Deletes an day type given by id and version", "operationId": "day-types_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/distance-matrix-elements": { "get": { "tags": [ "distance-matrix-elements" ], "summary": "Retrieves distance matrix elements and filter by query params", "operationId": "distance-matrix-elements_findByGroupIdOrVersionOrFareFrameId", "parameters": [ { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "The netexId to identify group the distance matrix elements belong to", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "groupVersion", "in": "query", "description": "The version of the group the distance matrix elements belong to", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of the pagination", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The size of the page", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DistanceMatrixElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "distance-matrix-elements" ], "summary": "Create a DistanceElement", "operationId": "distance-matrix-elements_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistanceMatrixElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging-possibilities": { "post": { "tags": [ "exchanging-possibilities" ], "summary": "Retrieves exchanging rules for given elements", "operationId": "exchanging-possibilities_getExchangingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterPossibilitiesRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangingAlternatives" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/meta-data/{id}/{version}": { "get": { "tags": [ "meta-data" ], "summary": "Get metadata for a netexid and version", "operationId": "meta-data_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex id to identify a metadata entry", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version id for the version of the metadata entry", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding/{id}/{version}": { "get": { "tags": [ "refunding" ], "summary": "Retrieves a refunding rule by id and version", "operationId": "refunding_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refunding" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "refunding" ], "summary": "Update a refunding rule", "operationId": "refunding_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the refunding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/replacing/{id}/{version}": { "get": { "tags": [ "replacing" ], "summary": "Retrieves replacing for id and version", "operationId": "replacing_getByIds", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Replacing", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Replacing", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Replacing" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "replacing" ], "summary": "Updates an existing Replacing", "operationId": "replacing_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Replacing", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Replacing", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Replacing" } } }, "required": true }, "responses": { "200": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "replacing" ], "summary": "Delete an existing replacing", "operationId": "replacing_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Replacing", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Replacing", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "Entity deleted successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/reserving/{id}/{version}": { "get": { "tags": [ "reserving" ], "summary": "Retrieves a reserving rule by id and version.", "operationId": "reserving_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID to identify a reserving.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The ID for the version of the reservation.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the reserving.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reserving" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "reserving" ], "summary": "Update a reserving rule", "operationId": "reserving_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID to identify a reserving.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The ID for the version of the reservation.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/reverting/{id}/{version}": { "get": { "tags": [ "reverting" ], "summary": "Retrieves reverting for id and version", "operationId": "reverting_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Reverting", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Reverting", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reverting" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "reverting" ], "summary": "Updates an existing Reverting", "operationId": "reverting_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Reverting", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Reverting", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reverting" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/roundings/{id}/{version}": { "get": { "tags": [ "roundings" ], "summary": "Retrieves rounding for id and version", "operationId": "roundings_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rounding" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "roundings" ], "summary": "Updates an existing rounding", "operationId": "roundings_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rounding" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "roundings" ], "summary": "Deletes a Rounding by id and version", "operationId": "roundings_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Rounding", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/security-policy/defaults": { "get": { "tags": [ "security-policy" ], "summary": "Retrieves default security policies", "operationId": "security-policy_getDefaults", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/supplement-products/{id}": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves the latest version of supplement products by id", "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": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the fare structure element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/timebands/{id}/{version}": { "get": { "tags": [ "timebands" ], "summary": "Retrieves time band for id and version", "operationId": "timebands_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Timeband", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Timeband", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timeband" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "timebands" ], "summary": "Update a time band", "operationId": "timebands_update", "parameters": [ { "name": "id", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timeband" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-usage-parameters": { "get": { "tags": [ "type-of-usage-parameters" ], "summary": "Retrieves all type of usage parameters.", "operationId": "type-of-usage-parameters_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfUsageParameter" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "type-of-usage-parameters" ], "summary": "Create type of usage parameter ", "operationId": "type-of-usage-parameters_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfUsageParameterInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/charging-moments/{id}": { "get": { "tags": [ "charging-moment-controller-v-1" ], "summary": "Retrieves a charging moment by id", "operationId": "charging-moment-controller-v-1_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a charging moment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the charging moment", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the charging moments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the charging moments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargingMoment" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/purchase-windows/{id}": { "get": { "tags": [ "purchase-windows" ], "summary": "Retrieves a purchase window by id", "operationId": "purchase-windows_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the purchase window", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the purchase windows version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the purchase windows version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseWindow" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements/count": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves the number of validable elements. Limit selection by setting the orgId or fareFrameId parameters", "operationId": "validable-elements_getCount", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements/pages": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves validable elements by organisation id or fareframe", "operationId": "validable-elements_findPagesByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a fare frame", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of elements to return", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The offset to start from", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidableElementPageWrapper" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/bucket-invalidation": { "post": { "tags": [ "admin/bucket-invalidation" ], "summary": "Queue GCS bucket invalidation for all entity types", "operationId": "admin/bucket-invalidation_invalidateAll", "parameters": [], "responses": { "202": { "description": "Invalidation queued" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging/{id}/{version}": { "get": { "tags": [ "exchanging" ], "summary": "Retrieves an exchanging rule by id and version", "operationId": "exchanging_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify an exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchanging" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "exchanging" ], "summary": "Update exchanging rule", "operationId": "exchanging_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify an exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the exchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/products/{id}": { "get": { "tags": [ "fare-tables" ], "summary": "Retrives a faretable by product id", "operationId": "fare-tables_getByFareProductId", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareTable" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products/{id}": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieve the latest version of preassignedFareProduct by id", "operationId": "preassigned-products_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the fare structure element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreassignedFareProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/product-tree-explanations": { "get": { "tags": [ "product-tree-explanations" ], "summary": "Retrieves all explanations", "operationId": "product-tree-explanations_get", "parameters": [ { "name": "nameOfClass", "in": "query", "description": "The nameOfClass to identify a ProductTreeExplained, i.e 'SalesPackage'", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from BCP-47, e.g. 'nb' or 'en'", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTreeExplained" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights/{id}": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieves newest sale discount right for id", "operationId": "sale-discount-rights_getByIdLatestVersionWithGpaDataSet", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaleDiscountRight" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-frames/{id}/{version}": { "get": { "tags": [ "fare-frames" ], "summary": "Retrives a fareFrames by id and version.", "operationId": "fare-frames_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fareFrames", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fareFrames", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareFrame" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/{id}/{version}": { "get": { "tags": [ "fare-tables" ], "summary": "Retrieves a fare table by id and version", "operationId": "fare-tables_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare table", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fare table", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "if set to true fare table cells will be omitted", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the fare table", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareTable" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fare-tables" ], "summary": "Update a faretable", "operationId": "fare-tables_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare table", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fare table", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareTableInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/general-groups-of-entities": { "get": { "tags": [ "general-groups-of-entities" ], "summary": "Retrieves all general groups of entities parameters", "operationId": "general-groups-of-entities_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralGroupOfEntities" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "general-groups-of-entities" ], "summary": "Create a general group of entities", "operationId": "general-groups-of-entities_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralGroupOfEntities" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products/count": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieves the number of preassignedFareProducts. Limiting selection by fareFrameId and orgId parameter is supported", "operationId": "preassigned-products_getPreassignedFareProductCount", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products/pages": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieves preassignedFareProducts for a given page. Limiting selection by fareFrameId and orgId parameter is supported", "operationId": "preassigned-products_findPageByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of elements listed in requested page", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The given page one want in return", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "language", "in": "query", "description": "the unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreassignedFareProductPageWrapper" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/round-trips/{id}/{version}": { "get": { "tags": [ "round-trips" ], "summary": "Retrives a roundtrip by id and version", "operationId": "round-trips_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a roundtrip", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the roundtrip", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundTrip" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "round-trips" ], "summary": "Update a round trips", "operationId": "round-trips_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a roundtrip", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the roundtrip", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundTripInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights/count": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieves the number of sale discount rights", "operationId": "sale-discount-rights_getCount", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Count" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights/pages": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported", "operationId": "sale-discount-rights_getPageWithGpaDataSet", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Size of page", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Page number", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusFilter", "in": "query", "description": "Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "DRAFT", "PROPOSED" ] } } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaleDiscountRightPageWrapper" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-fare-products/{id}": { "get": { "tags": [ "type-of-fare-products" ], "summary": "Retrieves type of fare product by id", "operationId": "type-of-fare-products_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of fare product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfFareProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/companion-profiles/{id}": { "get": { "tags": [ "companion-profiles" ], "summary": "Retrieves a companion profile by id", "operationId": "companion-profiles_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a companion profile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the companion profile", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the companion profiles version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the companion profiles version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanionProfile" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/frequencies-of-use/{id}": { "get": { "tags": [ "frequencies-of-use" ], "summary": "Retrieves frequencies of use by id", "operationId": "frequencies-of-use_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a frequency of use", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the frequency of use", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the frequency of use version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the frequency of use version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the frequencies of use", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyOfUse" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/type-of-concession/{id}": { "get": { "tags": [ "type-of-concession" ], "summary": "Retrives a type of concession by id", "operationId": "type-of-concession_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of concession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the type of concession", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the type of concessions version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the type of concessions version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOfConcession" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/validable-elements/{id}": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves validable elements by id and latest version", "operationId": "validable-elements_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validable element", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the validable element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the validable elements version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the validable elements version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValidableElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/capped-discount-rights/{id}": { "get": { "tags": [ "capped-discount-rights" ], "summary": "Retrieves the latest version of a capped discount right by id", "operationId": "capped-discount-rights_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the capped discount right", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the capped discount right", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "findActiveInEnvironment", "in": "query", "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", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CappedDiscountRight" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-intervals/{id}": { "get": { "tags": [ "geographical-intervals" ], "summary": "Retrives a geographical interval by id", "operationId": "geographical-intervals_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a geographical interval", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the geographical interval", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the geographical interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalInterval" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-responsibility-role": { "get": { "tags": [ "type-of-responsibility-role" ], "summary": "Retrieve all typeOfResponsibilityRoles", "operationId": "type-of-responsibility-role_getAll", "parameters": [ { "name": "orgId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/usage-validity-periods/{id}": { "get": { "tags": [ "usage-validity-periods" ], "summary": "Retrives a usage validity period by id", "operationId": "usage-validity-periods_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the usage validity period", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageValidityPeriod" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/supplement-products/{id}": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves the latest version of supplement product by id", "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": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the product", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-sections/{id}/{version}": { "get": { "tags": [ "fare-sections" ], "summary": "Retrieves fare section for id and version", "operationId": "fare-sections_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalStructureFactor" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fare-sections" ], "summary": "Updates an existing FareSection", "operationId": "fare-sections_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareSection" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "fare-sections" ], "summary": "Deletes a FareSection by id and version", "operationId": "fare-sections_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareSection", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/{id}": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrives a fare structure element by netexId", "operationId": "fare-structure-elements_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the fare structure element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FareStructureElement" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-intervals/batch": { "put": { "tags": [ "geographical-intervals" ], "summary": "Update multiple geographical intervals", "operationId": "geographical-intervals_updateMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "post": { "tags": [ "geographical-intervals" ], "summary": "Create a list of GeographicalIntervals", "operationId": "geographical-intervals_createMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqGeographicalIntervalInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/group-tickets/{id}/{version}": { "get": { "tags": [ "group-tickets" ], "summary": "Retrieves a group ticket by id and version", "operationId": "group-tickets_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the group ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupTicket" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "group-tickets" ], "summary": "Update a group ticket", "operationId": "group-tickets_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the group ticket", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupTicket" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policy-possibilities": { "post": { "tags": [ "penalty-policy-possibilities" ], "summary": "Retrieves penalty policy rules for given elements", "operationId": "penalty-policy-possibilities_getPenaltyPolicyPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterPossibilitiesRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicyAlternatives" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/usage-validity-periods/batch": { "put": { "tags": [ "usage-validity-periods" ], "summary": "Update a list of uvps", "operationId": "usage-validity-periods_updateMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "post": { "tags": [ "usage-validity-periods" ], "summary": "Create a list of uvp", "operationId": "usage-validity-periods_createMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqUsageValidityPeriodInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/user-profiles/{id}/{version}": { "get": { "tags": [ "user-profiles" ], "summary": "Retrives a userprofile by id and version", "operationId": "user-profiles_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a userprofile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the userprofile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfile" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "user-profiles" ], "summary": "Update a user profile", "operationId": "user-profiles_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a userprofile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the userprofile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/preassigned-products/{id}": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieves the latest version of preassignedFareProduct by id", "operationId": "preassigned-products_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the product", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PreassignedFareProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/amount-of-price-unit-products": { "get": { "tags": [ "amount-of-price-unit-products" ], "summary": "Retrieves an amount of price unit products, filtered by given parameter(s)", "operationId": "amount-of-price-unit-products_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "The unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmountOfPriceUnitProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "amount-of-price-unit-products" ], "summary": "Create an AmountOfPriceUnitProduct", "operationId": "amount-of-price-unit-products_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmountOfPriceUnitProduct" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-day-types/{id}/{version}": { "get": { "tags": [ "fare-day-types" ], "summary": "Retrieves fare day type for id and version", "operationId": "fare-day-types_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareDayType" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fare-day-types" ], "summary": "Updates an existing fare day type", "operationId": "fare-day-types_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareDayType" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "fare-day-types" ], "summary": "Deletes an day type given by id and version", "operationId": "fare-day-types_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the fare day type", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/count": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves the total number of fare structure elements. Limiting selection by fareFrameId or orgId parameter is supported", "operationId": "fare-structure-elements_getCount", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to idetify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/SeqStatusFilterEnum" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Entity updated successfully", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Count" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/pages": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves fareStructureElements for a given page. Limiting selection by fareFrameId or orgId parameter is supported", "operationId": "fare-structure-elements_findPageByOrganisationIdOrFareFrameId", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify data owned by organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of elements listed in requested page", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The given page one want in return", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusFilter", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/SeqStatusFilterEnum" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareStructureElementPageWrapper" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/generic-parameter-assignments": { "get": { "tags": [ "generic-parameter-assignments" ], "summary": "Retrieves generic parameter assignment by fare frame id or organisation", "operationId": "generic-parameter-assignments_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify the data owner.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify the data set to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Specify with 'a' or 'e' what set of gpa implementation should be retrieved", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "statusFilter", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/SeqStatusFilterEnum" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "generic-parameter-assignments" ], "summary": "Create a generic parameter assignment", "operationId": "generic-parameter-assignments_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericParameterAssignmentInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/interchangings/{id}/{version}": { "get": { "tags": [ "interchangings" ], "summary": "Retrieves an interchanging by id and version", "operationId": "interchangings_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a interchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the interchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the interchanging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interchanging" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "interchangings" ], "summary": "Update an interchanging", "operationId": "interchangings_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a interchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the interchanging", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterchangingInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sales-packages/{id}/{version}": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves a sales package by id", "operationId": "sales-packages_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPackage" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "sales-packages" ], "summary": "Update a sales-package", "operationId": "sales-packages_update_1", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPackageInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferability-possibilities": { "post": { "tags": [ "transferability-possibilities" ], "summary": "Retrieves transferability rules for given elements", "operationId": "transferability-possibilities_getTransferabilityPossibilities", "parameters": [ { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferabilityAlternatives" } } }, "required": true }, "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferabilityAlternatives" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/uvp-for-number-of-zones/batch": { "put": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Update a list of uvpForZones", "operationId": "uvp-for-number-of-zones_updateMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "post": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Create a list of uvp for number of zones", "operationId": "uvp-for-number-of-zones_createMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeqUVPForNumberOfZonesInsert" } } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/type-of-fare-products/{id}": { "get": { "tags": [ "type-of-fare-products" ], "summary": "Retrieves type of fare product by id", "operationId": "type-of-fare-products_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of fare product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the type of fare product", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the type of fare products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the type of fare products version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOfFareProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/valid-betweens/{id}/{version}": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrieves validable between by id and version. This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the given validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetween" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "valid-betweens" ], "summary": "Update a valid between. . This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the valid between", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the valid between", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetweenInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "valid-betweens" ], "summary": "Deletes a ValidBetween by id and version. This api is deprecated, use .../v2/valid-betweens", "operationId": "valid-betweens_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-structure-factors": { "get": { "tags": [ "geographical-structure-factors" ], "summary": "Retrieves all geographical structure factors", "operationId": "geographical-structure-factors_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "minimizeDataLoad", "in": "query", "description": "Possibility of opting out of including child elements", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicalStructureFactor" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "geographical-structure-factors" ], "summary": "Create a GeographicalStructureFactor", "operationId": "geographical-structure-factors_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalStructureFactor" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/security-policy/{id}/{version}": { "get": { "tags": [ "security-policy" ], "summary": "Retrieves security policy for id and version", "operationId": "security-policy_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SecurityPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the SecurityPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityPolicy" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "security-policy" ], "summary": "Updates an existing SecurityPolicy", "operationId": "security-policy_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SecurityPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the SecurityPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityPolicy" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/geographical-intervals/{id}": { "get": { "tags": [ "geographical-intervals" ], "summary": "Retrieves a geographical interval by id", "operationId": "geographical-intervals_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a geographical interval", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the geographical interval", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the geographical intervals version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the geographical intervals version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the geographical interval", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicalInterval" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/usage-validity-periods/{id}": { "get": { "tags": [ "usage-validity-periods" ], "summary": "Retrieves a usage validity period by id", "operationId": "usage-validity-periods_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the usage validity period", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the usage validity periods version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the usage validity periods version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UsageValidityPeriod" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements-usages/{id}": { "get": { "tags": [ "validable-elements-usages" ], "summary": "Retrieves references where the given validable element id is referenced", "operationId": "validable-elements-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex_id to identify a validable element ", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/charging-moments/{id}/{version}": { "get": { "tags": [ "charging-moments" ], "summary": "Retrieves charging moment for id and version", "operationId": "charging-moments_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ChargingMooment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ChargingMoment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargingMoment" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/journey-patterns/{id}/{version}": { "get": { "tags": [ "journey-patterns" ], "summary": "Retrieves journey pattern for id and version", "operationId": "journey-patterns_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyPattern" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "journey-patterns" ], "summary": "Updates an existing JourneyPattern", "operationId": "journey-patterns_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JourneyPattern" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "journey-patterns" ], "summary": "Deletes a JourneyPattern by id and version", "operationId": "journey-patterns_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the JourneyPattern", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policies/{id}/{version}": { "get": { "tags": [ "penalty Policy" ], "summary": "Retrieves penalty policy for id and version", "operationId": "penalty Policy_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a PenaltyPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the PenaltyPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PenaltyPolicy" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "penalty Policy" ], "summary": "Updates an existing PenaltyPolicy", "operationId": "penalty Policy_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a PenaltyPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the PenaltyPolicy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PenaltyPolicy" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "penalty Policy" ], "summary": "Deletes an penalty policy by id and version", "operationId": "penalty Policy_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify an penalty policy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the penalty policy", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/purchase-windows/{id}/{version}": { "get": { "tags": [ "purchase-windows" ], "summary": "Retrives a purchase window by id and version", "operationId": "purchase-windows_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseWindow" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "purchase-windows" ], "summary": "Update a purchase window", "operationId": "purchase-windows_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the purchase window", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseWindowInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/text-in-language/{id}/{version}": { "put": { "tags": [ "text-in-language" ], "summary": "Create or update name and description on an entity", "operationId": "text-in-language_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the entity", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the entity", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameAndDescription" } } }, "required": true }, "responses": { "204": { "description": "Entity set successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/fare-structure-elements/{id}": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves a fare structure element by netexId", "operationId": "fare-structure-elements_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the fare structure element", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the fare structure elements version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the fare structure elements version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FareStructureElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/uvp-for-number-of-zones/{id}": { "get": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Retrieves a uvpForNumberOfZones by id", "operationId": "uvp-for-number-of-zones_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a charging moment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the charging moment", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the charging moments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the charging moments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UVPForNumberOfZones" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/distribution-channel-usages/{id}": { "get": { "tags": [ "distribution-channel-usages" ], "summary": "Retrieves references where the distribution-channel with given id is referenced", "operationId": "distribution-channel-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex-id for a given distributionChannel the service should fong refences for.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/entitlement-given/{id}/{version}": { "get": { "tags": [ "entitlement-given" ], "summary": "Retrieves entitlement given for id and version", "operationId": "entitlement-given_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a EntitlementGiven", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the EntitlementGiven", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EntitlementGiven" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "entitlement-given" ], "summary": "Updates an existing EntitlementGiven", "operationId": "entitlement-given_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a EntitlementGiven", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the EntitlementGiven", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementGiven" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ] }, "delete": { "tags": [ "entitlement-given" ], "summary": "Deletes an entitlement given by id and version", "operationId": "entitlement-given_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify an entitlement given", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the entitlement given", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/luggage-allowances/{id}/versions": { "get": { "tags": [ "luggage-allowances" ], "summary": "Retrieves luggage allowance versions for a given id", "operationId": "luggage-allowances_getVersionsOrActiveById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "active", "in": "query", "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LuggageAllowance" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferabilities/{id}/{version}": { "get": { "tags": [ "transferabilities" ], "summary": "Retrieves transferabilities for id and version", "operationId": "transferabilities_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Transferability", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Transferability", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transferability" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "transferabilities" ], "summary": "Updates an existing Transferability", "operationId": "transferabilities_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Transferability", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Transferability", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transferability" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/distance-matrix-elements/{id}": { "get": { "tags": [ "distance-matrix-elements" ], "summary": "Retrives a distance matrix elment by id", "operationId": "distance-matrix-elements_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a distance matrix elment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the distance matrix elment", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the distance matrix elments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the distance matrix elments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the distance matrix elment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DistanceMatrixElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/type-of-usage-parameters/{id}": { "get": { "tags": [ "type-of-usage-parameters" ], "summary": "Retrieves type of usage parameter by id", "operationId": "type-of-usage-parameters_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of usage parameters", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the type of usage parameters", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the type of usage parameters version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the type of usage parameter version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOfUsageParameter" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/sales-packages/{id}/{version}": { "get": { "tags": [ "sales-packages" ], "summary": "Retrieves sales package given id and version", "operationId": "sales-packages_getByIdWithGpaDataSet", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SalesPackage" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "sales-packages" ], "summary": "Updates an existing sales package", "operationId": "sales-packages_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SalesPackage" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "sales-packages" ], "summary": "Delete a sales package given id and version", "operationId": "sales-packages_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the sales package", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "204": { "description": "Entity deleted successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/valid-betweens/{id}/{version}": { "get": { "tags": [ "valid-betweens" ], "summary": "Retrieves valid between for id and version", "operationId": "valid-betweens_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetween" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "valid-betweens" ], "summary": "Updates an existing ValidBetween", "operationId": "valid-betweens_update_1", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "X-Correlated-Id", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidBetween" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "valid-betweens" ], "summary": "Deletes a valid between by id and version", "operationId": "valid-betweens_deleteById_1", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ValidBetween", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "X-Correlated-Id", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/companion-profiles/{id}/{version}": { "get": { "tags": [ "companion-profiles" ], "summary": "Retrives a companion profile by id and version", "operationId": "companion-profiles_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a companion profile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the companion profile", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanionProfile" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-quota-factors/{id}/{version}": { "get": { "tags": [ "fare-quota-factors" ], "summary": "Retrieves fare quota factor for id and version", "operationId": "fare-quota-factors_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareQuotaFactor" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fare-quota-factors" ], "summary": "Updates an existing FareQuotaFactor", "operationId": "fare-quota-factors_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareQuotaFactor" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "fare-quota-factors" ], "summary": "Deletes a FareQuotaFactor by id and version", "operationId": "fare-quota-factors_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FareQuotaFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/frequencies-of-use/{id}/{version}": { "get": { "tags": [ "frequencies-of-use" ], "summary": "Retrieves frequencies of use by id and version", "operationId": "frequencies-of-use_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a frequency of use", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the frequency of use", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the frequencies of use", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrequencyOfUse" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "frequencies-of-use" ], "summary": "Update a frequency of use parameter.", "operationId": "frequencies-of-use_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a frequency of use", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the frequency of use", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrequencyOfUseInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fulfilment-methods/{id}/{version}": { "get": { "tags": [ "fulfilment-methods" ], "summary": "Retrieves fulfilment method for id and version", "operationId": "fulfilment-methods_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfilmentMethod" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fulfilment-methods" ], "summary": "Updates an existing FulfilmentMethod", "operationId": "fulfilment-methods_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfilmentMethod" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "fulfilment-methods" ], "summary": "Deletes a FulfilmentMethod by id and version", "operationId": "fulfilment-methods_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the FulfilmentMethod", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/group-of-distance-matrix-elements": { "get": { "tags": [ "group-of-distance-matrix-elements" ], "summary": "Retrieves all groups of distance matrix elements", "operationId": "group-of-distance-matrix-elements_getAll", "parameters": [ { "name": "orgId", "in": "query", "description": "The unique id to identify a organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify dataset to an organization", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "post": { "tags": [ "group-of-distance-matrix-elements" ], "summary": "Create a GroupOfDistanceElement", "operationId": "group-of-distance-matrix-elements_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupOfDistanceMatrixElementsInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/luggage-allowances/{id}/{version}": { "get": { "tags": [ "luggage-allowances" ], "summary": "Retrieves luggage allowance for id and version", "operationId": "luggage-allowances_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LuggageAllowance" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "luggage-allowances" ], "summary": "Updates an existing LuggageAllowance", "operationId": "luggage-allowances_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LuggageAllowance" } } }, "required": true }, "responses": { "200": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "luggage-allowances" ], "summary": "Delete an existing LuggageAllowance", "operationId": "luggage-allowances_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the LuggageAllowance", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Entity deleted successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-concession/{id}/{version}": { "get": { "tags": [ "type-of-concession" ], "summary": "Retrives a typeOfConcession by id and version", "operationId": "type-of-concession_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a typeOfConcession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the typeOfConcession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfConcession" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "type-of-concession" ], "summary": "Update a type of concession", "operationId": "type-of-concession_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a typeOfConcession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the typeOfConcession", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfConcessionInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/validable-elements/{id}/{version}": { "get": { "tags": [ "validable-elements" ], "summary": "Retrieves validable elements by id and version", "operationId": "validable-elements_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the given validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidableElement" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "validable-elements" ], "summary": "Update a validable element", "operationId": "validable-elements_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the given validable element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidableElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/amount-of-price-unit-products/{id}": { "get": { "tags": [ "amount-of-price-unit-products" ], "summary": "Retrieves the latest version of an AmountOfPriceUnitProduct by id", "operationId": "amount-of-price-unit-products_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the amount of price unit product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id of the version of the amount of price unit product", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmountOfPriceUnitProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-element-usages/{id}": { "get": { "tags": [ "fare-structure-element-usages" ], "summary": "Retrieves products/validable elements where the given FareStructureElement-id is referenced", "operationId": "fare-structure-element-usages_getMinimalVersionInfoById", "parameters": [ { "name": "id", "in": "path", "description": "The netex_id to identify a FareStructureElement", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MininmalVersionInfo" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/generic-parameter-assignments/{id}": { "get": { "tags": [ "generic-parameter-assignments" ], "summary": "Retrives a generic parameter assignment by id", "operationId": "generic-parameter-assignments_getById", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "description": "The id for the version of the generic parameter assignment", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericParameterAssignment" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/supplement-products/{id}/refunding": { "get": { "tags": [ "supplement-products" ], "summary": "Retrives refunding rules by fare product id and version", "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": [ { "name": "id", "in": "path", "description": "The unique id to identify a fareProduct", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "the unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "productVersionId", "in": "query", "description": "The version of the fareProduct", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refunding" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/supplement-products/{id}/{version}": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves the latest version of supplement product by id and version", "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": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "supplement-products" ], "summary": "Update a supplement product parameter.", "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": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/generic-parameter-assignments/batch": { "post": { "tags": [ "generic-parameter-assignments" ], "summary": "Create many generic parameter assignments", "operationId": "generic-parameter-assignments_createMany", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericParameterAssignmentInsert" } } }, "required": true }, "responses": { "201": { "description": "Entities created successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products/{id}/refunding": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrives refunding rules by fare product id and version", "operationId": "preassigned-products_getRefundingByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fareProduct", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "required": true, "style": "form", "explode": true, "schema": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "the unique id for the language", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "productVersionId", "in": "query", "description": "The version of the fareProduct", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refunding" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/preassigned-products/{id}/{version}": { "get": { "tags": [ "preassigned-products" ], "summary": "Retrieves the latest version of preassignedFareProduct by id and version", "operationId": "preassigned-products_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreassignedFareProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "preassigned-products" ], "summary": "Update a preassigned fare product parameter.", "operationId": "preassigned-products_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreassignedFareProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights/{id}/{version}": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieves sale discount right for id and version", "operationId": "sale-discount-rights_getByIdWithGpaDataSet", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaleDiscountRight" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "sale-discount-rights" ], "summary": "Updates an existing SaleDiscountRight", "operationId": "sale-discount-rights_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaleDiscountRight" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "sale-discount-rights" ], "summary": "Deletes a SaleDiscountRight by id and version", "operationId": "sale-discount-rights_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the SaleDiscountRight", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/versions/element-type/{nameOfClass}": { "get": { "tags": [ "versions" ], "summary": "Retrieves metadata of specific element type by class name", "operationId": "versions_getMinimalVersionInfoByClassOfName", "parameters": [ { "name": "nameOfClass", "in": "path", "description": "The unique class name to identify for an elementType", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MininmalVersionInfo" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/keys/count/{keyOfEntity}": { "get": { "tags": [ "admin/cache" ], "summary": "Count number of elements in cache by key of entity", "operationId": "admin/cache_getCount_1", "parameters": [ { "name": "keyOfEntity", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/cache/keys/info/{nameOfEntity}": { "get": { "tags": [ "admin/cache" ], "summary": "Get key info for a given entity in cache", "operationId": "admin/cache_getKeyInfo_1", "parameters": [ { "name": "nameOfEntity", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SetString" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/entitlements-required/{id}/{version}": { "get": { "tags": [ "entitlements-required" ], "summary": "Retrieves EntitlementRequired for id and version", "operationId": "entitlements-required_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRequired" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "entitlements-required" ], "summary": "Updates an existing EntitlementRequired", "operationId": "entitlements-required_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementRequired" } } }, "required": true }, "responses": { "200": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "entitlements-required" ], "summary": "Deletes an EntitlementRequired by id and version", "operationId": "entitlements-required_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify an EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the EntitlementRequired", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/service-facility-sets/{id}/{version}": { "get": { "tags": [ "service-facility-sets" ], "summary": "Retrieves service facility set for id and version", "operationId": "service-facility-sets_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFacilitySet" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "service-facility-sets" ], "summary": "Updates an existing ServiceFacilitySet", "operationId": "service-facility-sets_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFacilitySet" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "service-facility-sets" ], "summary": "Deletes a ServiceFacilitySet by id and version", "operationId": "service-facility-sets_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the ServiceFacilitySet", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-fare-products/{id}/{version}": { "get": { "tags": [ "type-of-fare-products" ], "summary": "Retrieves type of fare product by id", "operationId": "type-of-fare-products_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of fare product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfFareProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "type-of-fare-products" ], "summary": "Update a type of fare product", "operationId": "type-of-fare-products_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of fare product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfFareProductInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/supplement-products/{id}/versions": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves all versions of a supplement product", "operationId": "supplement-products_getVersionsOrActiveById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a supplement product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "active", "in": "query", "description": "If value is set to true only active versions will be returned, otherwise all versions will be returned", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2.SupplementProduct" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/capped-discount-rights/{id}/{version}": { "get": { "tags": [ "capped-discount-rights" ], "summary": "Retrieves a capped discount right by id and version", "operationId": "capped-discount-rights_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the capped discount right", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the capped discount right", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CappedDiscountRight" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "capped-discount-rights" ], "summary": "Update a capped discount right", "operationId": "capped-discount-rights_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the capped discount right", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the capped discount right", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CappedDiscountRightInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Already registered", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-intervals/{id}/{version}": { "get": { "tags": [ "geographical-intervals" ], "summary": "Retrives a geographical interval by id and version", "operationId": "geographical-intervals_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a geographical interval", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the geographical interval", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the geographical interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalInterval" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/usage-validity-periods/{id}/{version}": { "get": { "tags": [ "usage-validity-periods" ], "summary": "Retrives a usage validity period by id", "operationId": "usage-validity-periods_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageValidityPeriod" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "usage-validity-periods" ], "summary": "Update a usage validity period", "operationId": "usage-validity-periods_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the usage validity period", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageValidityPeriodInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v1/generic-parameter-assignments/{id}": { "get": { "tags": [ "generic-parameter-assignments" ], "summary": "Retrieves a generic parameter assignment by id", "operationId": "generic-parameter-assignments_getByIdV2", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The version status of the generic parameter assignment", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The from date of the generic parameter assignments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The to date of the generic parameter assignments version", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/v2/supplement-products/{id}/{version}": { "get": { "tags": [ "supplement-products" ], "summary": "Retrieves a supplement product by id and version", "operationId": "supplement-products_getByIdWithGpaDataSet", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a supplement product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the supplement product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the supplement product", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SupplementProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "supplement-products" ], "summary": "Updates an existing supplement product", "operationId": "supplement-products_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a supplement product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the supplement product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SupplementProduct" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/admin/bucket-invalidation/{entityType}": { "post": { "tags": [ "admin/bucket-invalidation" ], "summary": "Queue GCS bucket invalidation for a specific entity type", "operationId": "admin/bucket-invalidation_invalidateEntityType", "parameters": [ { "name": "entityType", "in": "path", "description": "Entity type: SalesPackage, FarePrice, FareTable, SaleDiscountRight, or UserProfile", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Invalidation queued" }, "400": { "description": "Invalid entity type", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-admin-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/availability-conditions/{id}/{version}": { "get": { "tags": [ "availability-conditions" ], "summary": "Retrieves Availability Condition for id and version", "operationId": "availability-conditions_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Availability Condition ", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Availability Condition", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AvailabilityCondition" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "availability-conditions" ], "summary": "Updates an existing Availability Condition", "operationId": "availability-conditions_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Availability Condition", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Availability Condition", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCondition" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "availability-conditions" ], "summary": "Deletes an AvailabilityCondition by id and version", "operationId": "availability-conditions_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a Availability Condition", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the Availability Condition", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/{id}/{version}": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrives a fare structure element by id and version", "operationId": "fare-structure-elements_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Languagecode", "in": "header", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FareStructureElement" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "fare-structure-elements" ], "summary": "Update a fare structure element", "operationId": "fare-structure-elements_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FareStructureElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/uvp-for-number-of-zones/{id}/{version}": { "get": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Retrives a UVPForNumberOfZones by id", "operationId": "uvp-for-number-of-zones_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a UVPForNumberOfZones", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the UVPForNumberOfZones", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "description": "The language code from ISO-639-3", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UVPForNumberOfZones" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "uvp-for-number-of-zones" ], "summary": "Update a uvpForNumberOfZones", "operationId": "uvp-for-number-of-zones_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a UVPForNumberOfZones", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the UVPForNumberOfZones", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UVPForNumberOfZonesInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/distance-matrix-elements/{id}/{version}": { "get": { "tags": [ "distance-matrix-elements" ], "summary": "Retrieves a distance-matrix-elements by id and version", "operationId": "distance-matrix-elements_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a charging moment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistanceMatrixElement" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/type-of-usage-parameters/{id}/{version}": { "get": { "tags": [ "type-of-usage-parameters" ], "summary": "Retrieves type of usage parameter by id and version", "operationId": "type-of-usage-parameters_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a type of usage parameters", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeOfUsageParameter" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/distance-matrix-elements/batch/{version}": { "put": { "tags": [ "distance-matrix-elements" ], "summary": "Update batch of distance matrix elements", "operationId": "distance-matrix-elements_updateMany", "parameters": [ { "name": "version", "in": "path", "description": "version", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistanceMatrixElementInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/product-tree-explanations/{id}/{version}": { "get": { "tags": [ "product-tree-explanations" ], "summary": "Retrieves explanation for netexId and version", "operationId": "product-tree-explanations_get_1", "parameters": [ { "name": "id", "in": "path", "description": "The netexId to identify a ProductTreeExplained", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "The version to identify a ProductTreeExplained", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from BCP-47, e.g. 'nb' or 'en'", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTreeExplained" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/general-groups-of-entities/{id}/{version}": { "get": { "tags": [ "general-groups-of-entities" ], "summary": "Retrieves general group of entities given id and version", "operationId": "general-groups-of-entities_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a GeneralGroupOfEntities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the GeneralGroupOfEntities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GeneralGroupOfEntities" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "general-groups-of-entities" ], "summary": "Updates an existing general group of entities", "operationId": "general-groups-of-entities_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a general group of entities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the general group of entities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralGroupOfEntities" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "general-groups-of-entities" ], "summary": "Delete a general group of entities given id and version", "operationId": "general-groups-of-entities_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a general group of entities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the general group of entities", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-structure-factors-usages/{id}": { "get": { "tags": [ "geographical-structure-factors-usages" ], "summary": "Retrieves references where the given GeographicalStructureFactor id is referenced", "operationId": "geographical-structure-factors-usages_getById", "parameters": [ { "name": "id", "in": "path", "description": "The netex_id to identify a GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUsages" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/sale-discount-rights/entitlement-given/{id}": { "get": { "tags": [ "sale-discount-rights" ], "summary": "Retrieves sale discount rights by id of the entitlement given they are connected to", "operationId": "sale-discount-rights_getByEntitlementGivenIdWithGpaDataSet", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify an EntitlementGiven", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SaleDiscountRight" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/versions/product-element-type/{nameOfClass}": { "get": { "tags": [ "versions" ], "summary": "Retrieves fare product metadata by class name, with optional typeOfFareProduct exclusion filter", "operationId": "versions_getMinimalProductVersionInfoByClassOfName", "parameters": [ { "name": "nameOfClass", "in": "path", "description": "The unique class name to identify for a fare product element type", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "fareFrameId", "in": "query", "description": "The unique id to identify a dataset to an organisation", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "excludeTypeOfFareProductId", "in": "query", "description": "A typeOfFareProduct netex ID whose products should be excluded from the result (e.g. ENT:TypeOfFareProduct:PersonalisationProgram). NOTE: Far from all products has this datatype set", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MininmalVersionInfo" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/amount-of-price-unit-products/{id}/{version}": { "get": { "tags": [ "amount-of-price-unit-products" ], "summary": "Retrieves an AmountOfPriceUnitProduct by id and version", "operationId": "amount-of-price-unit-products_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify the an amount of price unit product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the amount of price unit product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmountOfPriceUnitProduct" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "amount-of-price-unit-products" ], "summary": "Update an AmountOfPriceUnitProduct parameter.", "operationId": "amount-of-price-unit-products_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the amount of price unit product", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmountOfPriceUnitProduct" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/generic-parameter-assignments/{id}/{version}": { "get": { "tags": [ "generic-parameter-assignments" ], "summary": "Retrives a generic parameter assignment by id and version", "operationId": "generic-parameter-assignments_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "gpaDataSet", "in": "query", "description": "Type of gpa dataset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info" }, "304": { "description": "Not Modified" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "generic-parameter-assignments" ], "summary": "Update a generic parameter assignment", "operationId": "generic-parameter-assignments_update", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the generic parameter assignment", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericParameterAssignmentInsert" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-tables/{ftId}/cells/{cellId}/fare-prices": { "patch": { "tags": [ "fare-tables" ], "summary": "Updates a FarePrice for FareTable", "operationId": "fare-tables_updateFarePriceForFareTable", "parameters": [ { "name": "ftId", "in": "path", "description": "The id to identify a fare table", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "cellId", "in": "path", "description": "The id to identify a cell", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "query", "required": true, "style": "form", "explode": true, "schema": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "fareTableVersionId", "in": "query", "description": "The versjon of the fare table", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FarePriceUpdate" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-structure-factors/{id}/{version}": { "get": { "tags": [ "geographical-structure-factors" ], "summary": "Retrieves geographical structure factor for id and version", "operationId": "geographical-structure-factors_getById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalStructureFactor" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "put": { "tags": [ "geographical-structure-factors" ], "summary": "Updates an existing GeographicalStructureFactor", "operationId": "geographical-structure-factors_update", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicalStructureFactor" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "delete": { "tags": [ "geographical-structure-factors" ], "summary": "Deletes a GeographicalStructureFactor by id and version", "operationId": "geographical-structure-factors_deleteById", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the GeographicalStructureFactor", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } } ], "responses": { "200": { "description": "The resource was deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxedUnit" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/geographical-intervals/{giId}/fare-prices/{fpId}": { "patch": { "tags": [ "geographical-intervals" ], "summary": "Update price for a geographical interval by netexId", "operationId": "geographical-intervals_updateFarePrice", "parameters": [ { "name": "giId", "in": "path", "description": "The id to identify a geographical interval", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "fpId", "in": "path", "description": "The id to identify a fare price", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "giVersionId", "in": "query", "description": "The version id to identify a geographical interval", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FarePriceUpdate" } } }, "required": true }, "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Validation errors", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing Authorization", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Authorization failed", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:endre" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/group-of-distance-matrix-elements/{id}/{version}": { "get": { "tags": [ "group-of-distance-matrix-elements" ], "summary": "Retrieves a GroupOfDistanceMatrixElementsEntity by id and version", "operationId": "group-of-distance-matrix-elements_getByIdAndVersion", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a GroupOfDistanceMatrixElements", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id for the version of the GroupOfDistanceMatrixElements", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the info", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GroupOfDistanceMatrixElements" } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding-possibilities/sales-package/{id}/{version}": { "get": { "tags": [ "refunding-possibilities" ], "summary": "Retrieves refunding rules for given elements", "operationId": "refunding-possibilities_getSPRefundingPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refunding" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging-possibilities/sales-package/{id}/{version}": { "get": { "tags": [ "exchanging-possibilities" ], "summary": "Retrieves exchanging rules for given elements", "operationId": "exchanging-possibilities_getSPExchangingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique id to identify a sales package.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding-possibilities/validable-element/{id}/{version}": { "get": { "tags": [ "refunding-possibilities" ], "summary": "Retrieves refunding rules for given elements", "operationId": "refunding-possibilities_getVERefundingPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Refunding" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging-possibilities/validable-element/{id}/{version}": { "get": { "tags": [ "exchanging-possibilities" ], "summary": "Retrieves exchanging rules for given elements", "operationId": "exchanging-possibilities_getVEExchangingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The id to identify a validable element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policy-possibilities/sales-package/{id}/{version}": { "get": { "tags": [ "penalty-policy-possibilities" ], "summary": "Retrieves penalty policy rules for given elements", "operationId": "penalty-policy-possibilities_getSPPenaltyPolicyPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/refunding-possibilities/preassigned-product/{id}/{version}": { "get": { "tags": [ "refunding-possibilities" ], "summary": "Retrieves refunding rules for given elements", "operationId": "refunding-possibilities_getFPRefundingPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource." }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferability-possibilities/sales-package/{id}/{version}": { "get": { "tags": [ "transferability-possibilities" ], "summary": "Retrieves transferability rules for given elements", "operationId": "transferability-possibilities_getSPTransferabilityPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a sales package.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transferability" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging-possibilities/preassigned-product/{id}/{version}": { "get": { "tags": [ "exchanging-possibilities" ], "summary": "Retrieves exchanging rules for given elements", "operationId": "exchanging-possibilities_getFPExchangingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/{id}/{version}/geographical-intervals": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves the geographical intervals of the fare structure element", "operationId": "fare-structure-elements_getGeographicalIntervals", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limited numbers of geographical intervals returned in the set", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The offset of geographical intervals returned in the set", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicalInterval" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policy-possibilities/validable-element/{id}/{version}": { "get": { "tags": [ "penalty-policy-possibilities" ], "summary": "Retrieves penalty policy rules for given elements", "operationId": "penalty-policy-possibilities_getVEPenaltyPolicyPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a validable element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/exchanging-possibilities/fare-structure-element/{id}/{version}": { "get": { "tags": [ "exchanging-possibilities" ], "summary": "Retrieves exchanging rules for given elements", "operationId": "exchanging-possibilities_getFSEExchangingPossibilities", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The id to identify a fare structure element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Exchanging" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferability-possibilities/validable-element/{id}/{version}": { "get": { "tags": [ "transferability-possibilities" ], "summary": "Retrieves transferability rules for given elements", "operationId": "transferability-possibilities_getVETransferabilityPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a validable element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transferability" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/fare-structure-elements/{id}/{version}/distance-matrix-elements": { "get": { "tags": [ "fare-structure-elements" ], "summary": "Retrieves the distance matrix elements of the fare structure element", "description": "No longer in use. DMEs are connected by geographicalStructureFactors", "operationId": "fare-structure-elements_getPointToPointFares", "parameters": [ { "name": "id", "in": "path", "description": "The unique id to identify a fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The id of the version of the fare structure element", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code from ISO-639-3", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limited numbers of distance matrix elements returned in the set", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The offset of distance matrix elements returned in the set", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DistanceMatrixElement" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policy-possibilities/preassigned-product/{id}/{version}": { "get": { "tags": [ "penalty-policy-possibilities" ], "summary": "Retrieves penalty policy rules for given elements", "operationId": "penalty-policy-possibilities_getFPPenaltyPolicyPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferability-possibilities/preassigned-product/{id}/{version}": { "get": { "tags": [ "transferability-possibilities" ], "summary": "Retrieves transferability rules for given elements", "operationId": "transferability-possibilities_getFPTransferabilityPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a product.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transferability" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/penalty-policy-possibilities/fare-structure-element/{id}/{version}": { "get": { "tags": [ "penalty-policy-possibilities" ], "summary": "Retrieves penalty policy rules for given elements", "operationId": "penalty-policy-possibilities_getFSEPenaltyPolicyPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a fare structure element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] }, "/transferability-possibilities/fare-structure-element/{id}/{version}": { "get": { "tags": [ "transferability-possibilities" ], "summary": "Retrieves transferability rules for given elements", "operationId": "transferability-possibilities_getFSETransferabilityPossibilities", "parameters": [ { "name": "id", "in": "path", "description": "The id to identify a fare structure element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "version", "in": "path", "description": "The version of the element.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "The language code for the name and description fields.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "Entur-Distribution-Channel", "in": "header", "description": "The id of the distribution channel.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the resource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transferability" } } } } }, "304": { "description": "Not Modified" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "404": { "description": "Resource not found.", "content": { "application/problem+json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal server error.", "content": { "application/problem+json": { "schema": { "type": "string" } } } } }, "security": [ { "basic_auth": [] } ], "x-entur-permissions": { "value": "product-api-access:les" } }, "parameters": [ { "$ref": "#/components/parameters/ET-Client-Name" }, { "$ref": "#/components/parameters/X-Correlation-Id" } ] } }, "components": { "schemas": { "Cell": { "required": [ "changed", "created", "farePrice", "id", "modification", "nameOfClass", "priceableObjectRefs", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:Cell:5zoneAdult" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "farePrice": { "$ref": "#/components/schemas/FarePrice" }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Cell" ] }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "channelGroupRef": { "type": "object", "description": "Channel group reference" }, "priceableObjectRefs": { "type": "array", "description": "References to for example geographical interval and UserProfile", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "Count": { "required": [ "numberOfElements" ], "type": "object", "properties": { "numberOfElements": { "type": "integer", "description": "number of elements", "format": "int32", "examples": [ 369 ] } }, "description": "Count" }, "Tariff": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Tariff:Ordinary" ] }, "name": { "type": "array", "description": "Tariff Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Tariffs version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Tariff" ] }, "tariffBasis": { "type": "string", "description": "TariffBasis.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "validBetweenRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "returnFareTwiceSingle": { "type": "boolean", "description": "returnFareTwiceSingle" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A tariff" }, "DayType": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:DayType:BicycleFlatFare" ] }, "name": { "type": "array", "description": "Name of day type", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "dayLength": { "type": "string", "description": "Day length. Represented as a string formatted according to ISO-8601", "examples": [ "PT04H" ] }, "properties": { "type": "array", "description": "Properties of day", "items": { "$ref": "#/components/schemas/PropertyOfDay" } }, "description": { "type": "array", "description": "Description of day type", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "DayType" ] }, "earliestTime": { "type": "string", "description": "Earliest time.", "examples": [ "11:11:11" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "timebandRefs": { "type": "array", "description": "Time band references.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "durationAfterPropertiesOfDay": { "type": "string", "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", "examples": [ "PT7H" ] }, "durationBeforePropertiesOfDay": { "type": "string", "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", "examples": [ "PT24H" ] } }, "description": "The DayType describe during which the assignment applies" }, "Version": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "versionType" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:Version:RuterSingleTicket" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "default": "DRAFT", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "endDate": { "type": "string", "description": "EndDate", "format": "date-time" }, "startDate": { "type": "string", "description": "StartDate", "format": "date-time" }, "description": { "type": "string", "description": "Description." }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "Version" ] }, "versionType": { "type": "string", "description": "VersionType.", "enum": [ "BASELINE", "POINT" ] }, "modification": { "type": "string", "description": "Modification status", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] } }, "description": "A case class for versioning." }, "Metadata": { "required": [ "created", "id", "nameOfClass", "responsible", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:SalesPackage:Ordinary" ] }, "note": { "type": "string", "description": "Note", "examples": [ "Dette er en endring" ] }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "JourneyPattern" ] }, "responsible": { "minLength": 1, "type": "string", "description": "Responsible", "examples": [ "Kari Nordmann" ] }, "externalReferenceUrl": { "type": "string", "description": "External reference URL" }, "externalReferenceName": { "type": "string", "description": "External reference name" } } }, "Rounding": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "roundingMethod", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Rounding:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Rounding status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Rounding version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "Rounding" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A description of how prices are rounded post calculation", "deprecated": true }, "Timeband": { "required": [ "changed", "created", "dayOffset", "description", "endTime", "fareFrameRef", "id", "modification", "name", "nameOfClass", "startTime", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Timeband:2HoursValidPlus1" ] }, "name": { "type": "array", "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "endTime": { "type": "string", "description": "End time.", "examples": [ "11:11:11" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "timeZone": { "type": "string", "description": "Time zone.", "default": "Europe/Oslo", "examples": [ "Europe/Oslo" ] }, "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", "examples": [ 1 ] }, "startTime": { "type": "string", "description": "Start time.", "examples": [ "11:11:11" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "TimeBand" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "validityConditions": { "type": "array", "description": "ValidityConditions sequence.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true } }, "description": "The TimeBand describe during which the assignment applies" }, "BoxedUnit": { "type": "object" }, "FareFrame": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareFrame:Child" ] }, "name": { "type": "array", "description": "FareFrame Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "FareFrame version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "FareFrame" ] }, "vehicleMode": { "type": "string", "description": "Vehicle mode.", "enum": [ "AIR", "BUS", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TRAM", "UNKNOWN" ] }, "fareProducts": { "type": "array", "description": "FareProducts.", "items": { "$ref": "#/components/schemas/FareProduct" } }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "salesPackages": { "type": "array", "description": "SalesPackages.", "items": { "$ref": "#/components/schemas/SalesPackage" } }, "validableElements": { "type": "array", "description": "ValidableElements.", "items": { "$ref": "#/components/schemas/ValidableElement" } }, "typeOfFareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityConditions": { "type": "array", "description": "Validity condition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "fareStructureElements": { "type": "array", "description": "FareStructureElements.", "items": { "$ref": "#/components/schemas/FareStructureElement" } }, "typeOfFareFrameNetexId": { "type": "string", "description": "Type of fareFrame netexId." }, "typeOfFareFrameVersion": { "type": "string", "description": "Type of fareFrame version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true }, "transportOrganisationRef": { "type": "string", "description": "Transport organisation ref.", "examples": [ "CHILD" ] }, "transportOrganisationNetexId": { "type": "string", "description": "Transport organisation netexId." }, "transportOrganisationVersion": { "type": "string", "description": "Transport organisation version.", "examples": [ "4" ] }, "transportOrganisationNameOfClass": { "type": "string", "description": "Transport organisation nameOfClass.", "examples": [ "16" ] } }, "description": "A FareFrame" }, "FarePrice": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Id.", "examples": [ "NSB:FarePrice:1005TEN" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "amount": { "type": "string", "description": "Amount", "examples": [ "164.0" ] }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "ranking": { "type": "integer", "description": "Ranking.", "format": "int32", "examples": [ 1 ] }, "version": { "type": "string", "description": "Version.", "readOnly": true, "examples": [ "NSB:Version:V1" ] }, "currency": { "type": "string", "description": "Currency.", "examples": [ "NOK" ] }, "rounding": { "$ref": "#/components/schemas/Rounding" }, "isAllowed": { "type": "boolean", "description": "isAllowed.", "examples": [ true ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "FarePrice" ] }, "roundingRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "canBeCumulative": { "type": "boolean", "description": "canBeCumulative.", "examples": [ true ] }, "vatRegisterGroup": { "type": "string", "description": "vatRegisterGroup.", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ], "examples": [ "TRANSPORT_AND_TICKETS_VAT" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "discountPercentageUsed": { "maximum": 100, "minimum": -100, "type": "integer", "description": "discountPercentageUsed.", "format": "int32", "examples": [ 5 ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A description of the price and factor for a set fare" }, "FareTable": { "required": [ "cells", "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "prices", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareTable:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "cells": { "type": "array", "description": "Cell", "items": { "$ref": "#/components/schemas/Cell" } }, "prices": { "type": "array", "description": "FarePrice.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "endDate": { "type": "string", "description": "EndDate.", "format": "date", "examples": [ "2017-11-11" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "startDate": { "type": "string", "description": "StartDate.", "format": "date", "examples": [ "2017-11-11" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "FareTable" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the fare table", "readOnly": true }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A FareTable" }, "Refunding": { "required": [ "allowed", "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Refunding:FullRefundUntilLimit" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "hasFee": { "type": "boolean", "description": "Has fee." }, "prices": { "type": "array", "description": "Prices in different currencies for the refunding rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Refunding status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "allowed": { "type": "string", "description": "Allowed.", "enum": [ "NONE", "PARTIAL", "FULL" ], "examples": [ "FULL" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Refunding version.", "examples": [ "NSB:Version:V1" ] }, "refundType": { "type": "string", "description": "Refund type.", "enum": [ "UNUSED", "DELAY", "CANCELLATION", "PARTIAL_JOURNEY", "OTHER" ], "examples": [ "UNUSED" ] }, "resellWhen": { "type": "string", "description": "Event marking when the refundable status of the ticket changes.", "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" ], "examples": [ "NEVER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Refunding" ] }, "refundBasis": { "type": "string", "description": "Basis on which refund is made. See allowed values below.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "type": "string", "description": "Pricing rule." }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "canChangeClass": { "type": "boolean", "description": "Whether user can change class." }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "unusedTicketsOnly": { "type": "boolean", "description": "Unused tickets only." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "exchangeableFromAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded from any point after purchase." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "exchangeableFromDuration": { "type": "string", "description": "Exchangeable from duration.", "examples": [ "PT24H" ] }, "exchangeableUntilAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded until any point after purchase." }, "exchangeableUntilDuration": { "type": "string", "description": "Exchangeable until duration." }, "onlyAtCertainDistributionPoints": { "type": "boolean", "description": "Whether distribution is restricted to certain points." } }, "description": "Refunding" }, "Replacing": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Id.", "examples": [ "NSB:Replacing:SomeId" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "hasFee": { "type": "boolean", "description": "Has fee." }, "prices": { "type": "array", "description": "Fare prices for the replacing.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "allowed": { "type": "string", "description": "Allowed.", "enum": [ "NONE", "PARTIAL", "FULL" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "type": "string", "description": "The version of the replacing.", "examples": [ "ENT:Version:SomeVersion" ] }, "resellWhen": { "type": "string", "description": "Event marking when the exchangeable status of the ticket changes.", "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" ], "examples": [ "NEVER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "Replacing" ] }, "refundBasis": { "type": "string", "description": "Basis on which refund is made. See allowed values below.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare table.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "canChangeClass": { "type": "boolean", "description": "Whether user can change class." }, "unusedTicketsOnly": { "type": "boolean", "description": "Unused tickets only." }, "validityConditions": { "type": "array", "description": "Gives a sequence of conditions for validity.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "exchangeableFromAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded from any point after purchase." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true }, "exchangeableFromDuration": { "type": "string", "description": "Exchangeable from duration.", "examples": [ "PT24H" ] }, "exchangeableUntilAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded until any point after purchase." }, "exchangeableUntilDuration": { "type": "string", "description": "Exchangeable until duration." }, "onlyAtCertainDistributionPoints": { "type": "boolean", "description": "Whether distribution is restricted to certain points." } }, "description": "A Replacing" }, "Reserving": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Reserving:SeatAsAccommodationReserving" ] }, "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 reserving rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Reserving status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Reserving version.", "examples": [ "NSB:Version:V1" ] }, "feeBasis": { "type": "string", "description": "Fee basis.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Reserving" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "typeOfUsageParameter": { "type": "string", "description": "Type of usage parameter for the reservation.", "examples": [ "NSB:TypeOfUsageParameter:OpenSeating" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "reservationChargeType": { "type": "string", "description": "Type of charge for reservation.", "enum": [ "NONE", "SINGLE_FEE_FOR_RETURN_TRIP", "FEE_FOR_EACH_DIRECTION", "FEE_FOR_EACH_LEG" ], "examples": [ "NONE" ] }, "reservingRequirements": { "type": "string", "description": "Requirements for reservation.", "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" ], "examples": [ "RESERVATIONS_COMPULSORY" ] }, "maximumNumberToReserve": { "type": "integer", "description": "Maximum amount to reserve.", "format": "int32" }, "minimumNumberToReserve": { "type": "integer", "description": "Minimum amount to reserve.", "format": "int32" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "mustReserveWholeCompartment": { "type": "boolean", "description": "Must reserve whole compartment" } }, "description": "Reserving" }, "Reverting": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Id.", "examples": [ "NSB:Reverting:SelfService" ] }, "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 reverting rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Reverting status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "type": "string", "description": "Reverting version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "Reverting" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "allowedAfterControl": { "type": "boolean", "description": "Specifies if revert is allowed after control.", "default": false, "examples": [ true ] }, "maximumTimeAfterUse": { "type": "string", "description": "Maximum time after use Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "minimumTimeAfterUse": { "type": "string", "description": "Minimum time after use. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter.", "examples": [ "ENT:TypeOfUsageParameter:OpenSeating" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true }, "typeOfResponsibilityRoleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "Reverting" }, "RoundTrip": { "required": [ "changed", "created", "doubleSingleFare", "fareFrameRef", "id", "isRequired", "modification", "nameOfClass", "shortTrip", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:RoundTrip:Child" ] }, "name": { "type": "array", "description": "RoundTrip 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" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "RoundTrip version.", "examples": [ "NSB:Version:V1" ] }, "required": { "type": "boolean" }, "tripType": { "type": "string", "description": "Type of round trip", "enum": [ "SINGLE", "RETURN", "RETURN_ONLY", "MULTIPLE" ] }, "shortTrip": { "type": "boolean", "description": "Short trip", "examples": [ true ] }, "isRequired": { "type": "boolean", "description": "Is required." }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "RoundTrip" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables that provide prices or discounts for the round trip.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "doubleSingleFare": { "type": "boolean", "description": "Double single fare", "examples": [ true ] }, "validityConditions": { "type": "array", "description": "Validity conditions for the round trip.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A RoundTrip" }, "SetString": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "CellInsert": { "required": [ "fareFrameRef", "farePrice", "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:Cell:5zoneAdult" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "version": { "type": "string" }, "farePrice": { "$ref": "#/components/schemas/FarePriceInsert" }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareTableRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "channelGroupRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "priceableObjectRefs": { "type": "array", "description": "References to for example geographical interval and UserProfile", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "Exchanging": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Exchanging:MiniFlex" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "hasFee": { "type": "boolean", "description": "Has fee." }, "prices": { "type": "array", "description": "Prices in different currencies for the exchanging rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Exchanging status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "allowed": { "type": "string", "description": "Allowed.", "enum": [ "NONE", "PARTIAL", "FULL" ], "examples": [ "FULL" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Exchanging version.", "examples": [ "NSB:Version:V1" ] }, "resellWhen": { "type": "string", "description": "Event marking when the exchangeable status of the ticket changes.", "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" ], "examples": [ "NEVER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Exchanging" ] }, "refundBasis": { "type": "string", "description": "Basis on which refund is made. See allowed values below.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "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" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "canChangeClass": { "type": "boolean", "description": "Whether user can change class." }, "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" ] }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "specifiedProducts": { "type": "array", "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'", "items": { "type": "string" } }, "unusedTicketsOnly": { "type": "boolean", "description": "Unused tickets only." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "exchangeableFromAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded from any point after purchase." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "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.", "examples": [ "PT24H" ] }, "exchangeableUntilAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded until any point after purchase." }, "numberOfExchangesAllowed": { "type": "integer", "description": "Number of times a ticket may be exchanged.", "format": "int32" }, "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.", "examples": [ "PT24H" ] }, "onlyAtCertainDistributionPoints": { "type": "boolean", "description": "Whether distribution is restricted to certain points." } }, "description": "Exchanging" }, "CappingRule": { "required": [ "activeComparisonOperatorVariant", "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:CappingRule:EnkeltbillettTil24Timer" ] }, "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 fare.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "CappingRule" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "cappingPeriod": { "type": "string", "description": "Period over which capping applies.", "enum": [ "DAY", "WEEK", "MONTH" ], "examples": [ "DAY" ] }, "fareTableRefs": { "type": "array", "description": "Reference to fare table.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "validityConditions": { "type": "array", "description": "Validity conditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "preassignedFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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.", "examples": [ "A" ] } } }, "FareDayType": { "required": [ "changed", "created", "description", "id", "modification", "name", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareDayType:2HoursValidPlus1" ] }, "name": { "type": "array", "description": "Name of fare day type", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "dayLength": { "type": "string", "description": "Day length. Represented as a string formatted according to ISO-8601", "examples": [ "PT04H" ] }, "properties": { "type": "array", "description": "Properties of day", "items": { "$ref": "#/components/schemas/PropertyOfDay" } }, "description": { "type": "array", "description": "Description of fare day type", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "FareDayType" ] }, "earliestTime": { "type": "string", "description": "Earliest time.", "examples": [ "11:11:11" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "timebandRefs": { "type": "array", "description": "Time band references.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "durationAfterPropertiesOfDay": { "type": "string", "description": "Duration after properties of day. Represented as a string formatted according to ISO-8601", "examples": [ "PT7H" ] }, "durationBeforePropertiesOfDay": { "type": "string", "description": "Duration before properties of day. Represented as a string formatted according to ISO-8601", "examples": [ "PT24H" ] } }, "description": "The FareDayType describe during which the assignment applies" }, "FareProduct": { "required": [ "accessRightParameterAssignments", "accessRightsInProduct", "changed", "chargingMoment", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "validityConditions" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:PreassignedFareProduct:RuterSingleTicket" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "SalesPackage changed datetime." }, "created": { "type": "string", "description": "SalesPackage create datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "PreassignedFareProduct" ] }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the fareProduct" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "accessRightParameterAssignments": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active for this SP.", "examples": [ "A" ] } }, "description": "A FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT" }, "FareSection": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:FareSection:TrondheimOslo" ] }, "name": { "type": "array", "description": "Name", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "FareSection" ] }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "toFarePointRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fromFarePointRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "journeyPatternRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A Fare section." }, "GroupTicket": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GroupTicket:FamilyDiscount" ] }, "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" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "The version of the group ticket.", "examples": [ "NSB:Version:V1" ] }, "ticketing": { "type": "string", "description": "The type of way that tickets are issued to the group.", "enum": [ "ALL_ON_ONE_TICKET", "SEPARATE_TICKETS", "TICKET_WITH_COUPONS", "OTHER" ], "examples": [ "SEPARATE_TICKETS" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "GroupTicket" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "jointCheckIn": { "type": "string", "description": "jointCheckIn", "enum": [ "NONE", "ALLOWED", "REQUIRED" ] }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "pricingBasis": { "type": "string", "description": "Price basis", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables that provide prices or discounts for the group ticket.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "companionProfiles": { "type": "array", "description": "Companion Profiles in Group Ticket", "items": { "$ref": "#/components/schemas/CompanionProfile" } }, "groupDiscountBasis": { "type": "string", "description": "groupDiscountBasis", "enum": [ "FREE", "DISCOUNT_FOR_ALL", "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", "STEP_DISCOUNT", "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" ] }, "validityConditions": { "type": "array", "description": "Validity conditions for the group ticket.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "maximumNumberOfPersons": { "type": "integer", "description": "maximumNumberOfPersons", "format": "int32" }, "minimumNumberOfPersons": { "type": "integer", "description": "minimumNumberOfPersons", "format": "int32" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A GroupTicket" }, "OnboardStay": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:OnboardStay:Sleeper" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "duration": { "type": "string", "description": "Duration.", "examples": [ "PT24H" ] }, "fareClass": { "type": "string", "description": "Fareclass.", "enum": [ "FIRST_CLASS", "SECOND_CLASS", "THIRD_CLASS", "ECONOMY_CLASS", "BUSINESS_CLASS", "TURISTA", "PREFERENTE", "STANDARD_CLASS", "PREMIUM_CLASS", "ANY", "UNKNOWN" ], "examples": [ "FIRST_CLASS" ] }, "permission": { "type": "string", "description": "BoardingPermissionEnum.", "enum": [ "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE", "DELAYEDALIGHTINGPOSSIBLEAFTERARRIVAL", "OVERNIGHTSTAYONBOARDALLOWED" ], "examples": [ "EARLYBOARDINGPOSSIBLEBEFOREDEPARTURE" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "OnboardStay" ] }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] } }, "description": "An OnboardStay" }, "UserProfile": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:UserProfile:Child" ] }, "name": { "type": "array", "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "maxAge": { "type": "string", "description": "Maximum age.", "examples": [ "16" ] }, "minAge": { "type": "string", "description": "Minimum age.", "examples": [ "4" ] }, "prices": { "type": "array", "description": "Fare prices for the user profile.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UserProfile version.", "examples": [ "NSB:Version:V1" ] }, "userType": { "type": "string", "description": "UserType.", "enum": [ "ANYONE", "ADULT", "CHILD", "INFANT", "ANIMAL", "SENIOR", "GUIDE_DOG", "YOUTH", "STUDENT", "MILITARY" ], "examples": [ "CHILD" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "UserProfile" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables that provide prices or discounts for the user profile.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile", "readOnly": true }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" ] }, "companionProfiles": { "type": "array", "description": "Companion Profiles in Group Ticket", "items": { "$ref": "#/components/schemas/CompanionProfile" } }, "baseUserProfileRef": { "type": "string", "description": "The id of the base user profile which this profile is a specialization of." }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfConcessionRef": { "type": "string", "description": "typeOfConcessionRef." }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A UserProfile" }, "VatRegister": { "required": [ "description", "id", "validFrom", "vatGroup", "vatRate" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Id.", "examples": [ "ENT:VatRegister:SomeId" ] }, "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", "examples": [ "33" ] }, "vatRate": { "minLength": 1, "type": "string", "description": "The percentage rate for the VAT", "examples": [ "12.0" ] }, "vatGroup": { "type": "string", "description": "VAT group", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ], "examples": [ "TRANSPORT_AND_TICKETS_VAT" ] }, "validFrom": { "minLength": 1, "type": "string", "description": "The time and date from which the VAT is valid" }, "countryCode": { "type": "string", "description": "Country for which the VAT is valid, based on ISO 3166-1 alfa-3", "examples": [ "NOR" ] }, "description": { "minLength": 1, "type": "string", "description": "The VAT description", "examples": [ "Person transport and tickets in Norway" ] }, "organisationId": { "type": "integer", "description": "OrganisationId for the organisation who uses this VAT-specification.", "format": "int64" }, "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", "examples": [ "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", "examples": [ "NOR" ] } }, "description": "A case class for vat register." }, "AreaValidity": { "required": [ "changed", "created", "id", "minimumZonesForAreaValidity", "modification", "nameOfClass", "status", "typeOfAreaValidity", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:AreaValidity:RuterSingleTicket" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "readOnly": true, "examples": [ "RUT:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "AreaValidity" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "typeOfAreaValidity": { "type": "string", "description": "Type of area validity", "deprecated": true, "enum": [ "POINT_TO_POINT", "RING" ], "examples": [ "RING" ] }, "groupOfTariffZoneRef": { "type": "string", "description": "Group of tariff zone", "examples": [ "ENT:GroupOfTariffZone:abcdef" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true }, "minimumZonesForAreaValidity": { "type": "integer", "description": "Minimum no. of zones for area validity.", "format": "int32", "examples": [ 5 ] } }, "description": "Requirements for area validity." }, "FareTableRef": { "type": "object", "properties": { "ref": { "type": "string" }, "version": { "type": "string" }, "nameOfRefClass": { "type": "string" } } }, "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." }, "LimitingRule": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id." }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "LimitingRule" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "maximumPrice": { "type": "string", "description": "MaximumPrice.", "examples": [ "164.0" ] }, "minimumPrice": { "type": "string", "description": "MinimumPrice.", "examples": [ "164.0" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "canBeCumulative": { "type": "boolean", "description": "CanBeCumulative." }, "discountAsValue": { "type": "number", "description": "DiscountAsValue.", "format": "float" }, "minimumLimitPrice": { "type": "string", "description": "MinimumLimitPrice.", "examples": [ "164.0" ] }, "discountAsPercentage": { "type": "number", "description": "DiscountAsPercentage.", "format": "float" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "maximumPriceAsPercentage": { "type": "number", "description": "MaximumPriceAsPercentage.", "format": "double" } }, "description": "A LimitingRule" }, "SalesPackage": { "required": [ "accessRightParameterAssignments", "changed", "created", "distributionAssignments", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SalesPackage:Ordinary" ] }, "name": { "type": "array", "description": "SalesPackage Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "SalesPackage changed datetime." }, "created": { "type": "string", "description": "SalesPackage create datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "SalesPackage" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "vatGroupRegister": { "type": "string", "description": "VatGroupRegister is optional. No default value", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ] }, "salesPackageElements": { "type": "array", "description": "Sales package elements.", "items": { "$ref": "#/components/schemas/SalesPackageElement" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "distributionAssignments": { "type": "array", "description": "Distribution assignments.", "items": { "$ref": "#/components/schemas/DistributionAssignment" } }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "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.", "examples": [ "A" ] } }, "description": "A SalesPackage response" }, "TariffInsert": { "required": [ "fareFrameRef", "id", "name", "validBetweenRef", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:Tariff:Ordinary" ] }, "name": { "type": "array", "description": "Tariff 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": "Tariff version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "tariffBasis": { "type": "string", "description": "TariffBasis.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validBetweenRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "returnFareTwiceSingle": { "type": "boolean", "description": "returnFareTwiceSingle" } } }, "ValidBetween": { "required": [ "changed", "created", "fareFrameRef", "fromDate", "id", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ValidBetween:2018" ] }, "name": { "type": "array", "description": "Name of ValidBetween represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "toDate": { "type": "string", "description": "To Date." }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fromDate": { "type": "string", "description": "From Date." }, "description": { "type": "array", "description": "Description of ValidBetween represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "ValidBetween" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "validityConditions": { "type": "array", "description": "List of validityConditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } } }, "description": "A ValidBetween" }, "Accommodation": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Accommodation:Sleeper" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "Accommodation" ] }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "nuisanceFacilities": { "type": "array", "description": "List of nuisance facilities", "items": { "type": "string" } }, "accommodationFacility": { "type": "string", "description": "Accommodation facility.", "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" ], "examples": [ "SLEEPER" ] } }, "description": "An Accommodation" }, "ElementUsages": { "type": "object", "properties": { "elementRefs": { "type": "array", "description": "Parameters usages mapped to the requested parameter.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "description": "ParameterUsages" }, "Interchanging": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Interchanging:Trondelag" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "toMode": { "type": "string", "description": "Vehicle toMode.", "enum": [ "AIR", "BUS", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TRAM", "UNKNOWN" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fromMode": { "type": "string", "description": "Vehicle fromMode.", "enum": [ "AIR", "BUS", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TRAM", "UNKNOWN" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "Interchanging" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "maximumNumberOfChanges": { "type": "integer", "description": "MaximumNumberOfChanges.", "format": "int32" }, "typeOfUsageParameterRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "maximumTimeToMakeATransfer": { "type": "string", "description": "MaximumTimeToMakeATransfer" } } }, "PenaltyPolicy": { "required": [ "changed", "created", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:PenaltyPolicy:InspectionFeeYoung" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices in different currencies for the penalty policy.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed", "readOnly": true }, "created": { "type": "string", "description": "Created", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "NameOfClass", "readOnly": true, "examples": [ "PenaltyPolicy" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "paymentMethod": { "type": "string", "description": "PaymentMethod", "examples": [ "CASH" ] }, "penaltyAction": { "type": "string", "description": "PenaltyAction", "examples": [ "FINE" ] }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "penaltyPolicyType": { "type": "string", "description": "PenaltyPolicyType", "examples": [ "NO_TICKET" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "typeOfUsageParameterRef": { "type": "string", "description": "typeOfUsageParameter.", "examples": [ "ENT:TypeOfUsageParameter:OpenSeating" ] }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "minimumTimeBeforeReentry": { "type": "string", "description": "MinimumTimeBeforeReentry", "examples": [ "PT24H" ] }, "sameStationReentryPolicyType": { "type": "string", "description": "SameStationReentryPolicyType", "examples": [ "BLOCKED" ] } }, "description": "A PENALTY POLICY" }, "ProblemDetail": { "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "detail": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "instance": { "type": "string", "format": "uri" }, "properties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "PropertyOfDay": { "required": [ "countryRef", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of property of day", "examples": [ "Monday" ] }, "dayOfYear": { "type": "string", "description": "Day of year", "format": "##-##", "examples": [ "01-25" ] }, "countryRef": { "type": "string", "description": "Reference to country for holiday. ISO 3166-1", "readOnly": true, "examples": [ "NO" ] }, "daysOfWeek": { "type": "array", "description": "Days of week", "items": { "type": "string" } }, "description": { "type": "string", "description": "Description of the property of day", "examples": [ "Days family discount is available" ] }, "monthOfYear": { "type": "integer", "description": "Month of year", "format": "int32", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] }, "holidayTypes": { "type": "array", "description": "Holiday types", "items": { "type": "string" } } }, "description": "The DayType describe during which the assignment applies" }, "ChargingMoment": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ChargingMoment:Prepaid" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Charging moment status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Charging moment version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "ChargingMoment" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true } }, "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 }, "ChargingPolicy": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ChargingPolicy:Ordinary" ] }, "name": { "type": "array", "description": "ChargingPolicy name in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "ChargingPolicy changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "ChargingPolicy create datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "ChargingPolicy description in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "ChargingPolicy" ] }, "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" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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" ] }, "expireAfterPeriod": { "type": "string", "description": "Expire after period. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "paymentGracePeriod": { "type": "string", "description": "Payment grace period. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "typeOfUsageParameter": { "type": "string", "description": "type of UsageParameter." } }, "description": "A ChargingPolicy response" }, "FrequencyOfUse": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FrequencyOfUse:Single" ] }, "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 refunding rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Frequency of use changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Frequency of use created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Frequency of use version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "FrequencyOfUse" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "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" }, "frequencyOfUseType": { "type": "string", "description": "Frequency of use type.", "enum": [ "NONE", "SINGLE", "LIMITED", "UNLIMITED", "TWICE_A_DAY" ], "examples": [ "SINGLE" ] } }, "description": "Frequency of use" }, "JourneyPattern": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:JourneyPattern:TrondheimOslo" ] }, "name": { "type": "array", "description": "Name", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "FareSection" ] }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "farePointsInPattern": { "type": "array", "description": "Fare points in pattern. Versioned child of JourneyPattern", "items": { "$ref": "#/components/schemas/FarePointInPattern" } } }, "description": "A Journey Pattern" }, "PurchaseWindow": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:PurchaseWindow:Child" ] }, "name": { "type": "array", "description": "PurchaseWindow Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "PurchaseWindow version.", "examples": [ "NSB:Version:V1" ] }, "latestTime": { "type": "string", "description": "Latest time to purchase.", "examples": [ "23:59:59.999999999" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "PurchaseWindow" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "purchaseWhen": { "type": "string", "description": "When to purchase.", "enum": [ "TIME_OF_TRAVEL_ONLY", "DAY_OF_TRAVEL_ONLY", "ADVANCE_ONLY", "UNTIL_PREVIOUS_DAY", "ADVANCE_AND_DAY_OF_TRAVEL", "OTHER" ], "examples": [ "ADVANCE_AND_DAY_OF_TRAVEL" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "maxmumPeriodBeforeDeparture": { "type": "string", "description": "Maximum period before departure.", "examples": [ "23:59:59.999999999" ] }, "minimumPeriodBeforeDeparture": { "type": "string", "description": "Minimum period before departure.", "examples": [ "01:59:59.999999999" ] } }, "description": "A PurchaseWindow" }, "RoundingInsert": { "required": [ "fareFrameRef", "id", "roundingMethod", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Rounding:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Rounding version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" } }, "description": "Rounding.", "deprecated": true }, "SecurityPolicy": { "required": [ "changed", "created", "id", "minimumAccountSecurityLevel", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:SecurityPolicy:HighValueProduct" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed", "readOnly": true }, "created": { "type": "string", "description": "Created", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "NameOfClass", "readOnly": true, "examples": [ "SecurityPolicy" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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" } } }, "TextInLanguage": { "required": [ "lang", "value" ], "type": "object", "properties": { "lang": { "minLength": 1, "type": "string", "description": "Language code.", "examples": [ "nob" ] }, "value": { "minLength": 1, "type": "string", "description": "The text." } }, "description": "Text in a specific language." }, "FarePriceInsert": { "required": [ "fareFrameRef", "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FarePrice:1005TEN" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "amount": { "type": "string", "description": "Amount.", "examples": [ "164.0" ] }, "ranking": { "type": "integer", "description": "Ranking.", "format": "int32", "examples": [ 1 ] }, "version": { "type": "string" }, "currency": { "type": "string", "description": "Currency.", "examples": [ "NOK" ] }, "rounding": { "$ref": "#/components/schemas/RoundingInsert" }, "isAllowed": { "type": "boolean", "description": "isAllowed.", "examples": [ true ] }, "roundingRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "canBeCumulative": { "type": "boolean", "description": "canBeCumulative.", "examples": [ true ] }, "vatRegisterGroup": { "type": "string", "description": "vatRegisterGroup.", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ], "examples": [ "TRANSPORT_AND_TICKETS_VAT" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "discountPercentageUsed": { "type": "integer", "description": "discountPercentageUsed.", "format": "int32", "examples": [ 5 ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "FarePriceUpdate": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount in the currency selected at create operation", "format": "double", "examples": [ 16.5 ] }, "discountPercentageUsed": { "type": "integer", "description": "Discount in percentageUsed", "format": "int32", "examples": [ 40 ] } } }, "FareQuotaFactor": { "required": [ "changed", "created", "fareFrameRef", "fareStructureElementRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:FareQuotaFactor:SomeFareQuota4" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "value": { "type": "string", "description": "The value of fare quota factor." }, "prices": { "type": "array", "description": "Fare prices for the fare quota factor.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "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", "examples": [ "ENT:Version:SomeVersion4" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "FareQuotaFactor" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "numberOfUnits": { "type": "integer", "description": "The number of units.", "format": "int32" }, "validityConditions": { "type": "array", "description": "Gives a sequence of conditions for validity.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "fareStructureElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true } }, "description": "A FareQuotaFactor" }, "FareTableInsert": { "required": [ "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareTable:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "cells": { "type": "array", "description": "Cell", "items": { "$ref": "#/components/schemas/CellInsert" } }, "prices": { "type": "array", "description": "FarePrice.", "items": { "$ref": "#/components/schemas/FarePriceInsert" } }, "endDate": { "type": "string", "description": "EndDate.", "format": "date" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "startDate": { "type": "string", "description": "StartDate.", "format": "date" }, "tariffRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "MapStringObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "RefundingInsert": { "required": [ "allowed", "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:Refunding:SeatUpgrade" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "hasFee": { "type": "boolean", "description": "Has fee." }, "prices": { "type": "array", "description": "Prices in different currencies for the refunding rule.", "items": { "$ref": "#/components/schemas/FarePriceInsert" } }, "allowed": { "type": "string", "description": "Allowed.", "enum": [ "NONE", "PARTIAL", "FULL" ], "examples": [ "FULL" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UsageValidityPeriod version.", "examples": [ "NSB:Version:V1" ] }, "refundType": { "type": "string", "description": "Refund type.", "enum": [ "UNUSED", "DELAY", "CANCELLATION", "PARTIAL_JOURNEY", "OTHER" ], "examples": [ "UNUSED" ] }, "resellWhen": { "type": "string", "description": "Event marking when the refundable status of the ticket changes.", "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" ], "examples": [ "NEVER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "refundBasis": { "type": "string", "description": "Basis on which refund is made. See allowed values below.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "canChangeClass": { "type": "boolean", "description": "Whether user can change class." }, "unusedTicketsOnly": { "type": "boolean", "description": "Unused tickets only." }, "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." }, "onlyAtCertainDistributionPoints": { "type": "boolean", "description": "Whether distribution is restricted to certain points." } } }, "ReservingInsert": { "required": [ "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Reserving:SeatAsAccommodationReserving" ] }, "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" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Reserving version.", "examples": [ "NSB:Version:V1" ] }, "feeBasis": { "type": "string", "description": "Fee basis.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "typeOfUsageParameter": { "type": "string", "description": "Type of usage parameter for the reservation.", "examples": [ "NSB:TypeOfUsageParameter:ThroughFareInterchanging" ] }, "reservationChargeType": { "type": "string", "description": "Type of charge for reservation.", "enum": [ "NONE", "SINGLE_FEE_FOR_RETURN_TRIP", "FEE_FOR_EACH_DIRECTION", "FEE_FOR_EACH_LEG" ], "examples": [ "NONE" ] }, "reservingRequirements": { "type": "string", "description": "Requirements for reservation.", "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" ], "examples": [ "RESERVATIONS_COMPULSORY" ] }, "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" } } }, "RoundTripInsert": { "required": [ "doubleSingleFare", "fareFrameRef", "id", "isRequired", "name", "shortTrip", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:RoundTrip:Child" ] }, "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" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Round trip version.", "examples": [ "NSB:Version:V1" ] }, "required": { "type": "boolean" }, "tripType": { "type": "string", "description": "Type of round trip", "enum": [ "SINGLE", "RETURN", "RETURN_ONLY", "MULTIPLE" ] }, "shortTrip": { "type": "boolean", "description": "Short trip", "examples": [ true ] }, "isRequired": { "type": "boolean", "description": "Is required." }, "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 round trip.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "doubleSingleFare": { "type": "boolean", "description": "Double single fare", "examples": [ true ] }, "validityConditions": { "type": "array", "description": "Validity conditions for the round trip.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "examples": [ "NSB:Version:V1" ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "examples": [ "NSB:Version:V1" ] } }, "description": "A RoundTrip create request" }, "SteppedDuration": { "required": [ "initialDuration", "stepUnit", "subsequentStepsDuration" ], "type": "object", "properties": { "stepUnit": { "type": "string", "description": "Step unit.", "enum": [ "STOPS", "STOPS_INCLUDING_PASS_THROUGH_STOPS", "SECTIONS", "ZONES", "NETWORKS", "OPERATORS", "COUNTRIES" ], "examples": [ "ZONES" ] }, "initialDuration": { "type": "string", "description": "Initial duration. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "maximumDuration": { "type": "string", "description": "Maximum duration. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "subsequentStepsDuration": { "type": "string", "description": "Subsequent duration. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] } }, "description": "Stepped duration." }, "Transferability": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Transferability:NoTransfer" ] }, "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 transferability rule.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Transferability version.", "examples": [ "NSB:Version:V1" ] }, "canTransfer": { "type": "boolean", "description": "Whether ticket can be transferred to someone else.", "examples": [ false ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "Transferability" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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.", "examples": [ false ] }, "maximumNumberOfNamedUsers": { "type": "integer", "description": "Where a product can be used by a limited number of named users, maximum number of users allowed..", "format": "int32" } }, "description": "Transferability" }, "v2.SalesPackage": { "required": [ "changed", "created", "distributionAssignments", "fareFrameRef", "id", "modification", "nameOfClass", "status", "validityParameterAssignments", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:SalesPackage:Ordinary" ] }, "name": { "type": "array", "description": "Name", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "SalesPackage" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "vatGroupRegister": { "type": "string", "description": "VatGroupRegister is optional. No default value", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ] }, "salesPackageElements": { "type": "array", "description": "Sales package elements.", "items": { "$ref": "#/components/schemas/SalesPackageElement" } }, "distributionAssignments": { "type": "array", "description": "Distribution assignments.", "items": { "$ref": "#/components/schemas/v2.DistributionAssignment" } }, "validityParameterAssignments": { "type": "array", "description": "Validity Parameter assignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active for this SP.", "examples": [ "A" ] } }, "description": "SalesPackage" }, "CompanionProfile": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:CompanionProfile:Adult" ] }, "name": { "type": "array", "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices for the companion profile.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "The version of the companion profile.", "examples": [ "NSB:Version:V1" ] }, "parentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "ticketing": { "type": "string", "description": "The type of way that tickets are issued to the group.", "deprecated": true, "enum": [ "ALL_ON_ONE_TICKET", "SEPARATE_TICKETS", "TICKET_WITH_COUPONS", "OTHER" ], "examples": [ "SEPARATE_TICKETS" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "CompanionProfile" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "discountBasis": { "type": "string", "description": "Basis for discount.", "enum": [ "NONE", "FREE", "DISCOUNT", "FULLRATE" ], "examples": [ "DISCOUNT" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables that provide prices or discounts for the companion profile.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "userProfileId": { "type": "string", "description": "A user profile defining a category of people eligible to be a companion." }, "userProfileRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityConditions": { "type": "array", "description": "Validity conditions for the companion profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "generalGroupOfEntities": { "$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" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A companion profile" }, "ConditionSummary": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ConditionSummary:1005TEN" ] }, "isRefundable": { "type": "boolean", "description": "Whether the ticket is refundable.", "examples": [ true ] }, "isExchangeable": { "type": "boolean", "description": "Whether the ticket is exchangeable.", "examples": [ true ] } }, "description": "A summary of a condition." }, "EntitlementGiven": { "required": [ "changed", "created", "description", "entitlementType", "fareFrameRef", "id", "modification", "name", "nameOfClass", "prices", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:EntitlementGiven:TrondelagCustomerCard" ] }, "name": { "type": "array", "description": "The name of the entitlement given represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices for the entitlement given.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "EntitlementGiven" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "entitlementType": { "type": "string", "description": "Entitlement type", "enum": [ "USE", "PURCHASE", "PURCHASE_AT_DISCOUNT", "NONE" ] }, "entitlementConstraint": { "$ref": "#/components/schemas/EntitlementConstraint" }, "serviceAccessRightRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "minimumQualificationPeriod": { "type": "string", "description": "Minimum qualification period", "examples": [ "01:59:59.999999999" ] } } }, "ExchangingInsert": { "required": [ "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Exchanging:MiniFlex" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "hasFee": { "type": "boolean", "description": "Has fee." }, "prices": { "type": "array", "description": "Fare prices.", "items": { "$ref": "#/components/schemas/FarePriceInsert" } }, "allowed": { "type": "string", "description": "Allowed.", "enum": [ "NONE", "PARTIAL", "FULL" ], "examples": [ "FULL" ] }, "version": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UsageValidityPeriod version.", "examples": [ "NSB:Version:V1" ] }, "resellWhen": { "type": "string", "description": "Event marking when the exchangeable status of the ticket changes.", "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" ], "examples": [ "NEVER" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "refundBasis": { "type": "string", "description": "Basis on which refund is made. See allowed values below.", "enum": [ "PER_OFFER", "PER_PERSON" ], "examples": [ "PER_OFFER" ] }, "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" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "canChangeClass": { "type": "boolean", "description": "Whether user can change class." }, "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" ] }, "specifiedProducts": { "type": "string", "description": "Reference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'." }, "unusedTicketsOnly": { "type": "boolean", "description": "Unused tickets only." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "exchangeableFromAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded from any point after purchase." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "exchangeableFromDuration": { "type": "string", "description": "Exchangeable from duration.", "examples": [ "PT24H" ] }, "exchangeableUntilAnyTime": { "type": "boolean", "description": "Can be exchanged or refunded until any point after purchase." }, "numberOfExchangesAllowed": { "type": "integer", "description": "Number of times a ticket may be exchanged.", "format": "int32" }, "exchangeableUntilDuration": { "type": "string", "description": "Exchangeable until duration.", "examples": [ "PT24H" ] }, "onlyAtCertainDistributionPoints": { "type": "boolean", "description": "Whether distribution is restricted to certain points." } } }, "FulfilmentMethod": { "required": [ "changed", "created", "description", "fareFrameRef", "id", "name", "prices", "status", "typesOfTravelDocument", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FulfilmentMethod:TicketOffice" ] }, "name": { "type": "array", "description": "The name of the fulfilment method represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices for the fulfilment method.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "FulfilmentMethod" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "requiresCard": { "type": "boolean", "description": "Whether collecting ticket requires credit card used to purchase." }, "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" ] }, "typesOfTravelDocument": { "type": "array", "description": "Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "requiresBookingReference": { "type": "boolean", "description": "Whether collecting ticket requires booking reference." } } }, "GroupOfTimeBands": { "required": [ "changed", "created", "id", "members", "modification", "nameOfClass", "status", "validityConditions" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id." }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "members": { "type": "array", "description": "Members.", "items": { "$ref": "#/components/schemas/Timeband" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "FareStructureElement" ] }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "validityConditions": { "type": "array", "description": "ValidityConditions sequence.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A GroupOfTimeband describe during which the assignments applies" }, "LuggageAllowance": { "required": [ "changed", "created", "description", "fareFrameRef", "id", "modification", "name", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:LuggageAllowance:Bicycle" ] }, "name": { "type": "array", "description": "The name of the luggage allowance represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices for the luggage allowance.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "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" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "LuggageAllowance" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "baggageUseType": { "type": "string", "description": "Baggage Use Type", "enum": [ "CARRY_ON", "CHECK_IN", "OVERSIZE_CHECK_IN" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "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" ] } }, "description": "LuggageAllowance" }, "PeriodTicketInfo": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:PreassignedFareProduct:30Days" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "limitations": { "type": "array", "description": "Limitations as UsageParameters.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." } }, "description": "PeriodTicket with userprofiles and usage validity periods" }, "TypeOfConcession": { "required": [ "changed", "compatibleWithVersionRef", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:TypeOfConcession:Student" ] }, "name": { "type": "array", "description": "TypeOfConcession name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "TypeOfConcession version.", "examples": [ "NSB:Version:V1" ] }, "infolink": { "type": "string", "description": "An URL to more info about the type of concession" }, "description": { "type": "array", "description": "TypeOfConcession description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "TypeOfConcession" ] }, "privateCode": { "type": "string", "description": "A code to support interoperability with legacy systems" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "alternativeNames": { "type": "string", "description": "Alternative names for the type of concession" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A TypeOfConcession" }, "ValidableElement": { "required": [ "accessRightParameterAssignments", "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ValidableElement:Ordinary" ] }, "name": { "type": "array", "description": "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/FarePrice" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Validable element version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "ValidableElement" ] }, "areaValidity": { "$ref": "#/components/schemas/AreaValidity" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References for associated fare table.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "pricingRuleRef": { "type": "string", "description": "Pricing rule reference.", "examples": [ "unused" ] }, "validityConditions": { "type": "array", "description": "Gives a sequence of conditions for validity.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "fareStructureElementsRef": { "type": "array", "description": "The reference to the fare divided into a sequence.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "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.", "examples": [ "A" ] }, "fareStructureElementsInSequence": { "type": "array", "description": "The fare structure elements in sequence", "items": { "$ref": "#/components/schemas/FareStructureElementInSequence" } } }, "description": "A ValidationElement" }, "CappingRuleInsert": { "required": [ "accessRightParameterAssignmentRefs", "activeComparisonOperatorVariant", "fareFrameRef", "fareTableRefs", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:CappingRule:EnkeltbillettTil24Timer" ] }, "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/FarePrice" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "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" }, "cappingPeriod": { "type": "string", "description": "Period over which capping applies.", "enum": [ "DAY", "WEEK", "MONTH" ], "examples": [ "DAY" ] }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "preassignedFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether a gpa belongs to A or E gpa implementation.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "Access Right Parameter assignment references.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } } }, "GroupTicketInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GroupTicket:FamilyDiscount" ] }, "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" } }, "version": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "The version of the group ticket.", "examples": [ "NSB:Version:V1" ] }, "ticketing": { "type": "string", "description": "The type of way that tickets are issued to the group.", "enum": [ "ALL_ON_ONE_TICKET", "SEPARATE_TICKETS", "TICKET_WITH_COUPONS", "OTHER" ], "examples": [ "SEPARATE_TICKETS" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "jointCheckIn": { "type": "string", "description": "jointCheckIn", "enum": [ "NONE", "ALLOWED", "REQUIRED" ] }, "pricingBasis": { "type": "string", "description": "Price basis", "enum": [ "PER_OFFER", "PER_PERSON" ] }, "companionProfiles": { "type": "array", "description": "Companion Profiles in Group Ticket", "items": { "$ref": "#/components/schemas/CompanionProfile" } }, "groupDiscountBasis": { "type": "string", "description": "groupDiscountBasis", "enum": [ "FREE", "DISCOUNT_FOR_ALL", "DISCOUNT_FOR_FIRST_MEMBER_OF_GROUP", "STEP_DISCOUNT", "DISCOUNT_FOR_SECOND_AND_SUBSEQUENT_MEMBERS" ] }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "maximumNumberOfPersons": { "type": "integer", "description": "maximumNumberOfPersons", "format": "int32" }, "minimumNumberOfPersons": { "type": "integer", "description": "minimumNumberOfPersons", "format": "int32" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A group ticket create request" }, "PricingRuleEntity": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "$ref": "#/components/schemas/ListTextInLanguage" }, "version": { "type": "string" }, "description": { "$ref": "#/components/schemas/ListTextInLanguage" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "SaleDiscountRight": { "required": [ "accessRightParameterAssignments", "accessRightsInProduct", "changed", "chargingMoment", "created", "fareFrameRef", "id", "modification", "nameOfClass", "organisation", "prices", "status", "validityConditions", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:PreassignedFareProduct:RuterSingleTicket" ] }, "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 sdr.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "SalesPackage changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "SalesPackage create datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "PreassignedFareProduct" ] }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "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", "examples": [ "[\"IDENTIFIABLE_CUSTOMER\"]" ] }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef", "readOnly": true }, "accessRightParameterAssignments": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } }, "description": "A Sale Discount Right response" }, "SupplementProduct": { "required": [ "accessRightParameterAssignments", "accessRightsInProduct", "changed", "chargingMoment", "created", "fareFrameRef", "fareProductRefs", "fareTableRefs", "id", "modification", "nameOfClass", "organisation", "pricingRuleRef", "status", "validityConditions", "vatGroup", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SupplementProduct:BicycleReserving" ] }, "name": { "type": "array", "description": "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/FarePrice" } }, "status": { "type": "string", "description": "Supplement product status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Supplement product version.", "examples": [ "NSB:Version:V1" ] }, "vatGroup": { "type": "string", "description": "The VAT group for the SupplementProduct.", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "SupplementProduct" ] }, "operatorRef": { "type": "string", "description": "The reference to the operator.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "Privat code." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation." }, "fareTableRefs": { "type": "array", "description": "Reference to information about the fare.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "pricingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareProductRefs": { "type": "array", "description": "fareProductRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "fareStructureType": { "type": "string", "description": "FareStructureType", "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" ], "examples": [ "POINT_TO_POINT_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "validityConditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "accessRightsInProduct": { "type": "array", "description": "accessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "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" ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "accessRightParameterAssignments": { "type": "array", "description": "accessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } }, "description": "A SUPPLEMENT PRODUCT consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT and FARE PRODUCT" }, "TypeOfFareProduct": { "required": [ "changed", "created", "fareFrameRef", "id", "nameOfClass", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:TypeOfFareProduct:Ordinary" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Type of fare product status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Type of fare product version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "TypeOfFareProduct" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A classification of FARE PRODUCTs." }, "UserProfileInsert": { "required": [ "fareFrameRef", "id", "name", "proofOfIdentity", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:UserProfile:Child" ] }, "name": { "type": "array", "description": "UserProfile Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "maxAge": { "type": "integer", "description": "Maximum age.", "format": "int32", "examples": [ 16 ] }, "minAge": { "type": "integer", "description": "Minimum age.", "format": "int32", "examples": [ 4 ] }, "prices": { "type": "array", "description": "Fare prices for the user profile.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UserProfile version.", "examples": [ "NSB:Version:V1" ] }, "userType": { "type": "string", "description": "UserType.", "enum": [ "ANYONE", "ADULT", "CHILD", "INFANT", "ANIMAL", "SENIOR", "GUIDE_DOG", "YOUTH", "STUDENT", "MILITARY" ], "examples": [ "CHILD" ] }, "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" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" ] }, "companionProfiles": { "type": "array", "description": "Companion profiles describing users who may travel with user.", "items": { "$ref": "#/components/schemas/CompanionProfileInject" } }, "baseUserProfileRef": { "type": "string", "description": "The id of the base user profile which this profile is a specialization of." }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "companionProfileIds": { "type": "array", "description": "Companion profiles describing users who may travel with user.", "deprecated": true, "items": { "type": "string" } }, "typeOfConcessionRef": { "type": "string", "description": "typeOfConcessionRef." }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "examples": [ "NSB:Version:V1" ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "examples": [ "NSB:Version:V1" ] } }, "description": "A UserProfile create request" }, "ValidityCondition": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ValidBetween:2018" ] }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "toDate": { "type": "string", "description": "To Date." }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fromDate": { "type": "string", "description": "From Date." }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "ValidBetween" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] } }, "description": "A condition of the validity of the priceable object" }, "EntitlementProduct": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "validityConditions" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id.", "examples": [ "RUT:EntitlementProduct:PersonalTicket" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "EntitlementProduct" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef." } }, "description": "An ENTITLEMENT PRODUCT response." }, "FarePointInPattern": { "required": [ "id", "journeyPatternRef", "modification", "orderOfElement", "pointRef", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:FarePointInPattern:TrondheimOslo" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "type": "string", "description": "Version, will be a versioned child of journey pattern", "readOnly": true, "examples": [ "NSB:Version:V1" ] }, "pointRef": { "type": "string", "description": "Point Ref" }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "FarePointInPattern" ] }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "orderOfElement": { "type": "integer", "description": "Order of element", "format": "int32" }, "journeyPatternRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityConditions": { "type": "array", "description": "Validity Conditions.", "readOnly": true, "items": { "$ref": "#/components/schemas/ValidityCondition" } } }, "description": "A Fare Point In Pattern" }, "ListTextInLanguage": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "NameAndDescription": { "required": [ "description", "name" ], "type": "object", "properties": { "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } } } }, "SalesPackageInsert": { "required": [ "accessRightParameterAssignmentRefs", "distributionAssignments", "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "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" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UserProfile version.", "examples": [ "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.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "vatGroupRegister": { "type": "string", "description": "VatGroupRegister is optional. No default", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ] }, "salesPackageElements": { "type": "array", "description": "Sales package elements.", "items": { "$ref": "#/components/schemas/SalesPackageElementInsert" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "distributionAssignments": { "type": "array", "description": "Distribution assignments.", "items": { "$ref": "#/components/schemas/DistributionAssignmentInsert" } }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } } }, "ServiceFacilitySet": { "required": [ "changed", "created", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:ServiceFacilitySet:Ordinary" ] }, "name": { "type": "array", "description": "Name", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "ServiceFacilitySet" ] }, "onboardStay": { "$ref": "#/components/schemas/OnboardStay" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "accommodation": { "$ref": "#/components/schemas/Accommodation" } }, "description": "A ServiceFacilitySet" }, "ValidBetweenInsert": { "required": [ "fareFrameRef", "fromDate", "id" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ValidBetween:2018" ] }, "toDate": { "type": "string", "description": "To Date.", "examples": [ "2017-07-21T17:32:28Z" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fromDate": { "type": "string", "description": "From Date.", "examples": [ "2017-07-21T17:32:28Z" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityConditions": { "type": "array", "description": "List of validityConditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } } }, "description": "A ValidBetween create request" }, "VersionOfObjectRef": { "required": [ "nameOfClass", "ref", "version" ], "type": "object", "properties": { "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." }, "nameOfClass": { "minLength": 1, "type": "string", "description": "Name of class." } }, "description": "Fare frame ref." }, "CappedDiscountRight": { "required": [ "changed", "chargingMoment", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "validityConditions", "vatGroupRegister", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:CappedDiscountRight:BestePrisFylket" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "CappedDiscountRight" ] }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "cappingRules": { "type": "array", "description": "Capping rules.", "items": { "$ref": "#/components/schemas/CappingRule" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "vatGroupRegister": { "type": "string", "description": "VatGroupRegister.", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ], "examples": [ "TRANSPORT_AND_TICKETS_VAT" ] }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "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", "examples": [ "[\"IDENTIFIABLE_CUSTOMER\"]" ] }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "accessRightParameterAssignments": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } }, "description": "A Capped Discount Right response" }, "EntitlementRequired": { "required": [ "changed", "created", "description", "fareFrameRef", "id", "modification", "name", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "ENT:EntitlementRequired:SingleTicket" ] }, "name": { "type": "array", "description": "The name of the entitlement required represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices for the entitlement required.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "ENT:Version:ER-SingleTicket-1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "EntitlementRequired" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "validityConditions": { "type": "array", "description": "Pricing rule reference.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter.", "examples": [ "ENT:TypeOfUsageParameter:OpenSeating" ] }, "entitlementConstraint": { "$ref": "#/components/schemas/EntitlementConstraint" }, "serviceAccessRightNetexId": { "type": "string", "description": "Reference to the serviceAccessRight required.", "examples": [ "ENT:PreassignedFareProduct: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", "examples": [ "PT1H" ] } }, "description": "Entitlement Required." }, "InterchangingInsert": { "required": [ "fareFrameRef", "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:Interchanging:Trondelag" ] }, "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" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fromMode": { "type": "string", "description": "Vehicle fromMode.", "enum": [ "AIR", "BUS", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TRAM", "UNKNOWN" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "maximumNumberOfChanges": { "type": "integer", "description": "MaximumNumberOfChanges.", "format": "int32" }, "typeOfUsageParameterRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "maximumTimeToMakeATransfer": { "type": "string", "description": "MaximumTimeToMakeATransfer" } } }, "MininmalVersionInfo": { "required": [ "changed", "created", "id", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id.", "readOnly": true, "examples": [ "NSB:ElementTypeMetadata:Test" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "readOnly": true, "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "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 }, "version": { "type": "string", "description": "Version", "readOnly": true, "examples": [ "NSB:Version:V1" ] }, "startDate": { "type": "string", "description": "StartDate", "format": "date-time", "readOnly": true }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "ElementTypeMetadata" ] } }, "description": "MininmalVersionInfo" }, "PricingParameterSet": { "required": [ "changed", "compatibleWithVersionRef", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:PricingParameterSet:123abc" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "TypeOfUsageParameter" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "pricingrules": { "type": "array", "description": "Different rules that is common for the operator", "items": { "$ref": "#/components/schemas/PricingRuleEntity" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "SalesPackageElement": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SalesPackageElement:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "SalesPackageElement" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "References to fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "fareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "typeOfTravelDocumentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef." } }, "description": "A SalesPackageElement" }, "SeqStatusFilterEnum": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "UVPForNumberOfZones": { "required": [ "authorityId", "fareFrameRef", "id", "nameOfClass", "numberOfZones", "status", "usageValidityPeriodId", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:UVPForNumberOfZones:example" ] }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "zoneRange": { "type": "string", "description": "Zone range.", "examples": [ "4:9" ] }, "authorityId": { "type": "string", "description": "Reference to authority.", "examples": [ "RUT:Authority:RUT" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "UVPForNumberOfZones" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "numberOfZones": { "type": "integer", "description": "Number of zones.", "format": "int64", "examples": [ 3 ] }, "usageValidityPeriodId": { "type": "string", "description": "Reference to usage validity period.", "examples": [ "NSB:UsageValidityPeriod:Child" ] } } }, "UsageValidityPeriod": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:UsageValidityPeriod:Child" ] }, "name": { "type": "array", "description": "UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "UsageValidityPeriod version.", "examples": [ "NSB:Version:V1" ] }, "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" } }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "UsageValidityPeriod" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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" ] }, "fareTableRefs": { "type": "array", "description": "References to FareTable.", "items": { "$ref": "#/components/schemas/FareTableRef" } }, "activationMeans": { "type": "array", "description": "Activation Means. Describes how a product can be activated.", "items": { "type": "string" } }, "limitingRuleRef": { "$ref": "#/components/schemas/LimitingRule" }, "steppedDuration": { "$ref": "#/components/schemas/SteppedDuration" }, "standardDuration": { "type": "string", "description": "Standard duration. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "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" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "usageStartConstraintType": { "type": "string", "description": "Usage start constraint.", "enum": [ "VARIABLE", "FIXED", "FIXED_WINDOW" ] } }, "description": "A UsageValidityPeriod response" }, "AccessRightInProduct": { "required": [ "fareFrameRef", "id", "preassignedFareProductRef", "validableElementRef", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:AccessRightInProduct:Ordinary" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Access right in product status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Access right in product version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "Refunding" ] }, "accessNumber": { "type": "integer", "description": "The actual access number", "format": "int32" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "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" }, "orderOfElement": { "type": "integer", "description": "The actual order in the sequence", "format": "int32" }, "isLastInSequence": { "type": "boolean", "description": "Whether element is last in sequence" }, "isFirstInSequence": { "type": "boolean", "description": "Whether element is first in sequence" }, "limitedAccessNumber": { "type": "integer", "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", "format": "int32" }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessNumberIsLimited": { "type": "boolean", "description": "Flag indicating if access number is limited" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "preassignedFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "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." }, "ChargingMomentInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "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.", "examples": [ "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" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "FareStructureElement": { "required": [ "changed", "created", "fareFrameRef", "fareTableRefs", "geographicalIntervalRefs", "geographicalStructureFactorRefs", "id", "modification", "nameOfClass", "parameterAssignments", "pointToPointFareRefs", "qualityStructureFactorRefs", "status", "validityConditions" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareStructureElement:TENInterval" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "FareStructureElement" ] }, "tariffBasis": { "type": "string", "description": "Tariff basis.", "enum": [ "FLAT", "DISTANCE", "UNIT_SECTION", "ZONE", "ZONE_TO_ZONE", "POINT_TO_POINT", "ROUTE", "TOUR", "GROUP", "DISCOUNT", "PERIOD", "FREE", "OTHER" ], "examples": [ "DISTANCE" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "fare table reference", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile", "readOnly": true }, "validityConditions": { "type": "array", "description": "ValidityConditions sequence.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "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 'geographical structure factor'", "deprecated": true, "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "geographicalIntervalRefs": { "type": "array", "description": "geographical interval sequence", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "qualityStructureFactorRefs": { "type": "array", "description": "quality structure factor refs", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "geographicalStructureFactorRefs": { "type": "array", "description": "geographical structure factor refs", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "description": "A element describing the response structure of the fare" }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Number of the requested page. In case state is lost", "format": "int32", "examples": [ 369 ] } }, "description": "FareTablePageWrapper" }, "FrequencyOfUseInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FrequencyOfUse:Single" ] }, "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.", "examples": [ "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 for associated fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "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" }, "frequencyOfUseType": { "type": "string", "description": "Frequency of use type.", "enum": [ "NONE", "SINGLE", "LIMITED", "UNLIMITED", "TWICE_A_DAY" ], "examples": [ "SINGLE" ] } } }, "GeographicalInterval": { "required": [ "changed", "created", "fareFrameRef", "id", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GeographicalInterval:1364TEN" ] }, "prices": { "type": "array", "description": "Prices for the fare.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "GeographicalInterval" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "Reference to fare table.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "numberOfUnits": { "type": "number", "description": "numberOfUnits.", "format": "double" }, "validityConditions": { "type": "array", "description": "validityConditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "endGeographicalValue": { "type": "integer", "description": "endGeographicalValue.", "format": "int64" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "startGeographicalValue": { "type": "integer", "description": "startGeographicalValue.", "format": "int64" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "GeographicalInterval" }, "ProductTreeExplained": { "required": [ "description", "explainedElementDescription", "explainedElementName", "id", "name", "severity", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id for root component/element", "readOnly": true, "examples": [ "NSB:SalesPackage:SomeSalesPackage" ] }, "name": { "type": "array", "description": "Name of the root element represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "reason": { "type": "string", "description": "Reason for failed tree", "readOnly": true, "examples": [ "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, "examples": [ "NSB:Version:V1" ] }, "messages": { "$ref": "#/components/schemas/SeqExplainedMessageResponse" }, "severity": { "type": "string", "description": "Severity of the explained event. 'error' drops the tree; 'warning' is published alongside the tree", "readOnly": true, "enum": [ "error", "warning" ], "examples": [ "error" ] }, "description": { "type": "array", "description": "Description of the root element represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "minLength": 1, "type": "string", "description": "nameOfClass", "readOnly": true, "examples": [ "SalesPackage" ] }, "explainedElementId": { "type": "string", "description": "The netexId of the explained element", "readOnly": true }, "explainedElementName": { "type": "array", "description": "Name of the explained element represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "originalErrorMessage": { "type": "string", "description": "The original error message thrown", "readOnly": true }, "explainedElementVersion": { "type": "string", "description": "The version of the explained element", "readOnly": true }, "explainedElementDescription": { "type": "array", "description": "Description of the explained element represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "explainedElementNameOfClass": { "type": "string", "description": "The nameOfClass of the explained element", "readOnly": true } }, "description": "Schema for presenting explained messages for failed product trees" }, "PurchaseWindowInsert": { "required": [ "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:PurchaseWindow:90days" ] }, "name": { "type": "array", "description": "PurchaseWindow 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": "PurchaseWindow version.", "examples": [ "NSB:Version:V1" ] }, "latestTime": { "type": "string", "description": "Latest time.", "examples": [ "23:59:59" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "purchaseWhen": { "type": "string", "description": "When to purchase.", "enum": [ "TIME_OF_TRAVEL_ONLY", "DAY_OF_TRAVEL_ONLY", "ADVANCE_ONLY", "UNTIL_PREVIOUS_DAY", "ADVANCE_AND_DAY_OF_TRAVEL", "OTHER" ], "examples": [ "ADVANCE_AND_DAY_OF_TRAVEL" ] }, "maxmumPeriodBeforeDeparture": { "type": "string", "description": "Maximum period before departure.", "examples": [ "PT2160H" ] }, "minimumPeriodBeforeDeparture": { "type": "string", "description": "Minimum period before departure.", "examples": [ "PT2160H" ] } } }, "SeqSaleDiscountRight": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "TypeOfUsageParameter": { "required": [ "changed", "compatibleWithVersionRef", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:TypeOfUsageParameter:abc123" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "TypeOfUsageParameter" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "VersionBatchRetrieve": { "required": [ "entityIds" ], "type": "object", "properties": { "entityIds": { "type": "array", "description": "entityIds", "items": { "type": "string" }, "examples": [ [ "ENT:PreassignedFareProduct:abc123", "ENT:PreassignedFareProduct:123abc" ] ] } }, "description": "A case class for versioning." }, "v2.SupplementProduct": { "required": [ "changed", "chargingMomentRef", "created", "fareFrameRef", "id", "modification", "nameOfClass", "operatorRef", "organisationRef", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SupplementProduct:BicycleReserving" ] }, "name": { "type": "array", "description": "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/FarePrice" } }, "status": { "type": "string", "description": "Supplement product status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Supplement product version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "SupplementProduct" ] }, "operatorRef": { "type": "string", "description": "The reference to the operator.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "Privat code." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "fareTableRefs": { "type": "array", "description": "Reference to information about the fare.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "organisationRef": { "type": "string", "description": "The reference to the organisation.", "examples": [ "ENT:Authority:ENT" ] }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "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" ] }, "chargingMomentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareStructureType": { "type": "string", "description": "FareStructureType", "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" ], "examples": [ "POINT_TO_POINT_FARE" ] }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "validityConditions.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "typeOfFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessRightsInProduct": { "type": "array", "description": "accessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "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" ] }, "accessRightParameterAssignments": { "type": "array", "description": "accessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } }, "description": "A Supplement product consisting of one or several validable elements, specific to a charging moment and fare product" }, "AvailabilityCondition": { "required": [ "changed", "created", "fareFrameRef", "fromDate", "id", "isAvailable", "modification", "nameOfClass", "status", "toDate", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:AvailabilityCondition:SomeId" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "toDate": { "type": "string", "description": "toDate datetime." }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "AvailabilityCondition version.", "examples": [ "ENT:Version:SomeVersion" ] }, "fromDate": { "type": "string", "description": "FromDate datetime." }, "available": { "type": "boolean" }, "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" } }, "isAvailable": { "type": "boolean", "description": "Is available" }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "AvailabilityCondition" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "timebandRefs": { "type": "array", "description": "Time band references.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" } }, "description": "An AvailabilityCondition" }, "DistanceMatrixElement": { "required": [ "changed", "created", "fareFrameRef", "id", "nameOfClass", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:DistanceMatrixElement:NSR167ToNSR359" ] }, "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/FarePrice" } }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "groupId": { "type": "integer", "description": "Group id.", "format": "int64", "examples": [ 4 ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "DistanceMatrixElement version.", "examples": [ "NSB:Version:V1" ] }, "distance": { "type": "number", "description": "Distance.", "format": "double", "examples": [ 16.4 ] }, "groupRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "isDirect": { "type": "boolean", "description": "Is a direct route.", "examples": [ true ] }, "tariffId": { "type": "integer", "description": "Tariff id.", "format": "int64" }, "tariffRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "DistanceMatrixElement" ] }, "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" } }, "endFareZoneRef": { "type": "string", "description": "End fare zone reference." }, "inverseAllowed": { "type": "boolean", "description": "Inverse is allowed.", "examples": [ true ] }, "endTariffZoneId": { "type": "string", "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef.", "deprecated": true }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "relativeRanking": { "type": "integer", "description": "Relative ranking.", "format": "int32", "examples": [ 2 ] }, "startFareZoneRef": { "type": "string", "description": "Start fare zone reference." }, "startTariffZoneId": { "type": "string", "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef.", "deprecated": true }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "endScheduledStopPointId": { "type": "string", "description": "End scheduled stop point netexId." }, "startScheduledStopPointId": { "type": "string", "description": "Start scheduled stop point netexId." } }, "description": "A DistanceMatrixElement" }, "EntitlementConstraint": { "required": [ "nameOfClass" ], "type": "object", "properties": { "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "EntitlementConstraint" ] }, "userConstraint": { "type": "string", "description": "User constraint", "enum": [ "ANYONE", "SAME_PERSON", "DIFFERENT_PERSON", "SPECIFIC" ] }, "routeConstraint": { "type": "string", "description": "Route constraint", "enum": [ "ANY", "SAME", "OPPOSITE_DIRECTION", "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" ] }, "specificProfiles": { "type": "array", "description": "Specific user profiles which entitlement applies", "items": { "type": "string" } }, "journeyConstraint": { "type": "string", "description": "Journey constraint", "enum": [ "ANY", "SAME", "SIMILAR", "DIFFERENT" ] }, "operatorConstraint": { "type": "string", "description": "Operator constraint", "enum": [ "ANY", "SAME", "PARTICIPATING", "DIFFERENT" ] }, "directionConstraint": { "type": "string", "description": "Direction constraint", "enum": [ "ANY", "SAME", "OPPOSITE_DIRECTION", "DIFFERENT" ] }, "classOfUseConstraint": { "type": "string", "description": "Class of use constraint", "enum": [ "ANY", "SAME", "SAME_OR_EQUIVALENT", "DIFFERENT" ] }, "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" ] }, "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" ] }, "fareScheduledStopPoints": { "type": "array", "description": "Fare scheduled stop points which entitlement applies", "items": { "$ref": "#/components/schemas/FareScheduledStopPoint" } }, "typeOfTravelDocumentConstraint": { "type": "string", "description": "Type of travel document constraint", "enum": [ "ANY", "SAME", "SAME_MEDIA", "SAME_SMART_CARD", "SAME_MOBILE_APP", "DIFFERENT" ] }, "typeOfProductCategoryConstraint": { "type": "string", "description": "Type of product category constraint", "enum": [ "ANY", "SAME", "SAME_OR_EQUIVALENT", "DIFFERENT" ] } }, "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 }, "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." }, "CompanionProfileInject": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:CompanionProfile:Adult" ] }, "name": { "type": "array", "description": "The name of the companion profile represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices for the companion profile.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "The version of the companion profile.", "examples": [ "NSB:Version:V1" ] }, "parentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "ticketing": { "type": "string", "description": "The type of way that tickets are issued to the group.", "deprecated": true, "enum": [ "ALL_ON_ONE_TICKET", "SEPARATE_TICKETS", "TICKET_WITH_COUPONS", "OTHER" ], "examples": [ "SEPARATE_TICKETS" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "discountBasis": { "type": "string", "description": "Basis for discount.", "enum": [ "NONE", "FREE", "DISCOUNT", "FULLRATE" ], "examples": [ "DISCOUNT" ] }, "userProfileId": { "type": "string", "description": "A user profile defining a category of people eligible to be a companion." }, "userProfileRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "typeOfUsageParameter": { "type": "string", "description": "typeOfUsageParameter." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "generalGroupOfEntities": { "$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" }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A companion profile create request" }, "ConditionSummaryInsert": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ConditionSummary:1005TEN" ] }, "isRefundable": { "type": "boolean", "description": "Whether the ticket is refundable.", "examples": [ true ] }, "isExchangeable": { "type": "boolean", "description": "Whether the ticket is exchangeable.", "examples": [ true ] } }, "description": "ConditionSummary." }, "DistributionAssignment": { "required": [ "allDistributionChannelsRef", "changed", "created", "distributionRights", "fareFrameRef", "id", "modification", "nameOfClass", "organisationRef", "paymentMethods", "salesPackageRef", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:DistributionAssignment:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "countryRef": { "type": "string", "description": "Country reference." }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "DistributionAssignment" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "finalCarrier": { "type": "boolean", "description": "Flag for final carrier." }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "anyCountryRef": { "type": "boolean", "description": "Flag for allowed in any country." }, "initialCarrier": { "type": "boolean", "description": "Flag for initial carrier." }, "paymentMethods": { "type": "array", "description": "Payment methods.", "items": { "type": "string" } }, "transitCarrier": { "type": "boolean", "description": "Flag for transit carrier." }, "organisationRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "allowedInChannel": { "type": "boolean", "description": "Flag for allowed in channel." }, "allowedInCountry": { "type": "boolean", "description": "Flag for allowed in country." }, "mandatoryProduct": { "type": "boolean", "description": "Flag for mandatory product." }, "ticketingServices": { "type": "array", "description": "Ticketing services.", "items": { "type": "string" } }, "allOrganisationRef": { "type": "boolean", "description": "Flag for all organisations." }, "distributionRights": { "type": "string", "description": "Distribution rights.", "enum": [ "NONE", "SELL", "REFUND", "EXCHANGE", "INFROM", "PRIVATE", "OTHER" ], "examples": [ "SELL" ] }, "fulfilmentMethodRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "restrictedToChannel": { "type": "boolean", "description": "Flag for restricted to channel." }, "topographicPlaceRef": { "type": "string", "description": "Topographical place reference." }, "requiresRegistration": { "type": "boolean", "description": "Flag for requires registration." }, "responsibilitySetRef": { "type": "string", "description": "Responsibility set reference." }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "serviceAccessRightRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" ] }, "groupOfSalesPackagesRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef." }, "allDistributionChannelsRef": { "type": "boolean", "description": "Flag for distribution in all channels." }, "groupOfDistributionChannelsRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A distributionAssignment" }, "ExchangingAlternatives": { "required": [ "exchangingOptions", "ref" ], "type": "object", "properties": { "ref": { "$ref": "#/components/schemas/IdAndVersion" }, "exchangingOptions": { "type": "array", "description": "Exchanging alternatives for this element.", "items": { "$ref": "#/components/schemas/Exchanging" } } }, "description": "Exchanging alternatives for an element." }, "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" }, "GeneralGroupOfEntities": { "required": [ "changed", "created", "fareFrameRef", "id", "members", "modification", "nameOfClass", "nameOfMemberClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:GeneralGroupOfEntities:SomeId" ] }, "name": { "type": "array", "description": "GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "members": { "type": "array", "description": "Member refs.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "GeneralGroupOfEntities version.", "examples": [ "ENT:Version:SomeVersion" ] }, "description": { "type": "array", "description": "GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "GeneralGroupOfEntities" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "nameOfMemberClass": { "type": "string", "description": "Name of member class" }, "validityConditions": { "type": "array", "description": "Validity conditions for the general group of entities.", "readOnly": true, "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version.", "readOnly": true } }, "description": "General Group of Entities." }, "PreassignedFareProduct": { "required": [ "accessRightParameterAssignments", "accessRightsInProduct", "changed", "chargingMoment", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "validityConditions", "vatGroupRegister" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:PreassignedFareProduct:RuterSingleTicket" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Fare prices.", "items": { "$ref": "#/components/schemas/FarePrice" } }, "status": { "type": "string", "description": "Status.", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "PreassignedFareProduct" ] }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "productType": { "type": "string", "description": "The type of fare product.", "enum": [ "SINGLE_TRIP", "TIME_LIMITED_SINGLE_TRIP", "PERIOD_PASS" ], "examples": [ "SINGLE_TRIP" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "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" ] }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "POINT_TO_POINT_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef." }, "accessRightParameterAssignments": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } }, "description": "A PREASSIGNED FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT." }, "TypeOfConcessionInsert": { "required": [ "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:TypeOfConcession:Student" ] }, "name": { "type": "array", "description": "TypeOfConcession 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": "TypeOfConcession version.", "examples": [ "NSB:Version:V1" ] }, "infolink": { "type": "string", "description": "An URL to more info about the type of concession" }, "description": { "type": "array", "description": "TypeOfConcession description 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" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "alternativeNames": { "type": "string", "description": "Alternative names for the type of concession" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A TypeOfConcession" }, "ValidableElementInsert": { "required": [ "description", "fareFrameRef", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "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.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "areaValidity": { "$ref": "#/components/schemas/AreaValidity" }, "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" } }, "fareStructureElementsRef": { "type": "array", "description": "The reference to the fare divided into a sequence.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "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.", "examples": [ "A" ] }, "fareStructureElementsInSequence": { "type": "array", "description": "Fare structure elements in sequence", "items": { "$ref": "#/components/schemas/FareStructureElementInSequenceInsert" } } } }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "readOnly": true, "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Number of the requested page. In case state is lost", "format": "int32", "readOnly": true, "examples": [ 13 ] } }, "description": "SalesPackagePageWrapper" }, "SupplementProductInsert": { "required": [ "chargingMomentRef", "fareFrameRef", "id", "name", "operatorRef", "organisation", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SupplementProduct:LargeAnimal" ] }, "name": { "type": "array", "description": "Name.", "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": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "operatorRef": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "organisation": { "minLength": 1, "type": "string", "description": "Organisation." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummaryInsert" }, "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" ] }, "chargingMomentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "typeOfFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProductInsert" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "supplementProductType": { "type": "string", "description": "SupplementProductType.", "enum": [ "SEAT_RESERVATION", "BICYCLE", "DOG", "ANIMAL", "MEAL", "WIFI", "EXTRA_LUGGAGE", "PENALTY", "UPGRADE", "JOURNEY_EXTENSION", "JOURNEY_ADD_ON", "EVENT_ADD_ON", "PARKING" ], "examples": [ "SEAT_RESERVATION" ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } } }, "TypeOfFareProductInsert": { "required": [ "fareFrameRef", "id" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "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.", "examples": [ "NSB:Version:V1" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } } }, "AmountOfPriceUnitProduct": { "required": [ "amount", "chargingMoment", "chargingMomentRef", "fareFrameRef", "id", "modification", "productType", "status" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:AmountOfPriceUnitProduct:RuterCarnetTicket" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "amount": { "minimum": 1, "type": "integer", "description": "Amount. Must be greater than 0.", "format": "int32", "examples": [ 10 ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "AmountOfPriceUnitProduct" ] }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "productType": { "type": "string", "description": "AmountOfPriceUnitProductType.", "enum": [ "TRIP_CARNET", "PASS_CARNET", "UNIT_COUPON", "STORED_VALUE", "OTHER" ], "examples": [ "TRIP_CARNET" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "organisation": { "type": "string", "description": "Organisation who own the product." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "chargingMoment": { "$ref": "#/components/schemas/ChargingMoment" }, "organisationId": { "type": "string", "description": "Organisation related to the userProfile" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummary" }, "chargingMomentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "typeOfFareProduct": { "$ref": "#/components/schemas/TypeOfFareProduct" }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "validityConditions": { "type": "array", "description": "ValidityCondition.", "readOnly": true, "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProduct" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "readOnly": true }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef", "readOnly": true }, "accessRightParameterAssignments": { "type": "array", "description": "AccessRightParameterAssignments.", "readOnly": true, "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "AccessRightParameterAssignmentRefs.", "writeOnly": true, "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "description": "An Amount Of Price Unit Product response" }, "ScopingValidityParameter": { "required": [ "changed", "created", "fareFrameRef", "genericParameterAssignmentRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ScopingValidityParameter:OperatorNSB" ] }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "lineRef": { "type": "string", "description": "LineRef." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "lineType": { "type": "string", "description": "LineType.", "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" ], "examples": [ "EXPRESS" ] }, "placeUse": { "type": "string", "description": "PlaceUse", "enum": [ "START_AT", "END_AT", "VIA", "RESTRICT_TO", "OTHER" ] }, "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" } }, "fareZoneRef": { "type": "string", "description": "FareZoneRef.", "examples": [ "KOL:FareZone:250" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "ScopingValidityParameter" ] }, "operatorRef": { "type": "string", "description": "Operator referance." }, "vehicleMode": { "type": "string", "description": "VehicleModeRef.", "enum": [ "AIR", "BUS", "COACH", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TAXI", "TRAM", "UNKNOWN" ] }, "authorityRef": { "type": "string", "description": "AuthorityRef.", "examples": [ "NSB:Authority:NSB" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "tariffZoneRef": { "type": "string", "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef.", "deprecated": true, "examples": [ "RUT:TariffZone:2S" ] }, "facilitySetRef": { "type": "string", "description": "facilitySetRef." }, "fareSectionRef": { "type": "string", "description": "Fare section ref." }, "groupOfLinesRef": { "type": "string", "description": "Group of Lines ref.", "examples": [ "ENT:GroupOfLines:AllLines" ] }, "transportSubmode": { "type": "string", "description": "TransportSubmode.", "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" ], "examples": [ "expressBus" ] }, "topographicPlaceRef": { "type": "string", "description": "TopographicPlaceRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "groupOfTariffZonesRef": { "type": "string", "description": "Group of Tariff Zones ref.", "examples": [ "ENT:GroupOfTariffZones:AllZones" ] }, "scheduledStopPointRef": { "type": "string", "description": "Scheduled stop Point ref." }, "distributionChannelRef": { "type": "string", "description": "Distribution channel ref.", "examples": [ "ENT:DistributionChannel:App" ] }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef." }, "genericParameterAssignmentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A ScopingValidityParameter" }, "CappedDiscountRightInsert": { "required": [ "chargingMomentRef", "fareFrameRef", "id", "name", "operatorRef", "organisation", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:CappedDiscountRight:BestePrisFylket" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "prices": { "type": "array", "description": "Prices.", "items": { "$ref": "#/components/schemas/FarePriceInsert" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "operatorRef": { "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "cappingRules": { "type": "array", "description": "Capping rules.", "items": { "$ref": "#/components/schemas/CappingRuleInsert" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "organisation": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Organisation." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummaryInsert" }, "vatGroupRegister": { "type": "string", "description": "VatGroupRegister.", "default": "TRANSPORT_AND_TICKETS_VAT", "enum": [ "EXCEPTION_FROM_VAT", "GENERAL_VAT", "FOOD_VAT", "TRANSPORT_AND_TICKETS_VAT" ] }, "chargingMomentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "typeOfFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProductInsert" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "validationRequirements": { "type": "string", "description": "A set of validation requirement enums with allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED", "examples": [ "[\"IDENTIFIABLE_CUSTOMER\"]" ] }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } } }, "PenaltyPolicyAlternatives": { "required": [ "penaltyOptions", "ref" ], "type": "object", "properties": { "ref": { "$ref": "#/components/schemas/IdAndVersion" }, "penaltyOptions": { "type": "array", "description": "Penalty policy alternatives for this element.", "items": { "$ref": "#/components/schemas/PenaltyPolicy" } } }, "description": "Penalty policy alternatives for an element." }, "SalesPackageElementInsert": { "required": [ "fareFrameRef", "fareTableRefs", "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:SalesPackageElement:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRule": { "$ref": "#/components/schemas/LimitingRule" }, "fareTableRefs": { "type": "array", "description": "References to fare tables.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "fareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "typeOfTravelDocumentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" } } }, "TemporalValidityParameter": { "required": [ "changed", "created", "genericParameterAssignmentRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:TemporalValidityParameter:OperatorNSB" ] }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "dayType": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "TemporalValidityParameter" ] }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "groupOfTimeBands": { "$ref": "#/components/schemas/GroupOfTimeBands" }, "validityCondition": { "$ref": "#/components/schemas/ValidityCondition" }, "validityConditionRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "genericParameterAssignmentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A TemporalValidityParameter" }, "UVPForNumberOfZonesInsert": { "required": [ "authorityId", "fareFrameRef", "id", "numberOfZones", "usageValidityPeriodId" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:UVPForNumberOFZones:123" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "zoneRange": { "type": "string", "description": "Zone range.", "examples": [ "4:9" ] }, "authorityId": { "type": "string", "description": "Reference to authority.", "examples": [ "RUT:Authority:RUT" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "numberOfZones": { "type": "integer", "description": "Number of zones.", "format": "int64", "examples": [ 3 ] }, "usageValidityPeriodId": { "type": "string", "description": "Reference to usage validity period.", "examples": [ "NSB:UsageValidityPeriod:Child" ] } } }, "UsageValidityPeriodInsert": { "required": [ "fareFrameRef", "fareTableRefs", "id", "name", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:UsageValidityPeriod:30Days" ] }, "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": "UsageValidityPeriod version.", "examples": [ "NSB:Version:V1" ] }, "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" } }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" ] }, "fareTableRefs": { "type": "array", "description": "References to FareTable.", "items": { "$ref": "#/components/schemas/FareTableRef" } }, "activationMeans": { "type": "array", "description": "Activation Means. Describes how a product can be activated.", "items": { "type": "string" } }, "steppedDuration": { "$ref": "#/components/schemas/SteppedDuration" }, "standardDuration": { "type": "string", "description": "Standard duration. Represented as a string formatted according to ISO-8601", "examples": [ "PT1H" ] }, "usageValidityTypes": { "type": "array", "description": "Usage validity type list.", "items": { "type": "string" } }, "usageStartConstraintType": { "type": "string", "description": "Usage start constraint.", "enum": [ "VARIABLE", "FIXED", "FIXED_WINDOW" ] } } }, "v2.DistributionAssignment": { "required": [ "allDistributionChannelsRef", "changed", "created", "distributionRights", "fareFrameRef", "id", "modification", "nameOfClass", "organisationRef", "paymentMethods", "salesPackageRef", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:DistributionAssignment:Ordinary" ] }, "name": { "type": "array", "description": "The name of the distribution assignment represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "countryRef": { "type": "string", "description": "Country reference." }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "DistributionAssignment" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "finalCarrier": { "type": "boolean", "description": "Flag for final carrier." }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "anyCountryRef": { "type": "boolean", "description": "Flag for allowed in any country." }, "initialCarrier": { "type": "boolean", "description": "Flag for initial carrier." }, "paymentMethods": { "type": "array", "description": "Payment methods.", "items": { "type": "string", "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" ], "examples": [ "CREDIT_CARD" ] } }, "transitCarrier": { "type": "boolean", "description": "Flag for transit carrier." }, "organisationRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "allowedInChannel": { "type": "boolean", "description": "Flag for allowed in channel." }, "allowedInCountry": { "type": "boolean", "description": "Flag for allowed in country." }, "mandatoryProduct": { "type": "boolean", "description": "Flag for mandatory product." }, "ticketingServices": { "type": "array", "description": "Ticketing services.", "items": { "type": "string", "enum": [ "TSF_PURCHASE", "COLLECTION", "CARD_TOP_UP", "RESERVATIONS" ] } }, "allOrganisationRef": { "type": "boolean", "description": "Flag for all organisations." }, "distributionRights": { "type": "string", "description": "Distribution rights.", "enum": [ "NONE", "SELL", "REFUND", "EXCHANGE", "INFROM", "PRIVATE", "OTHER" ], "examples": [ "SELL" ] }, "fulfilmentMethodRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "restrictedToChannel": { "type": "boolean", "description": "Flag for restricted to channel." }, "topographicPlaceRef": { "type": "string", "description": "Topographical place reference." }, "requiresRegistration": { "type": "boolean", "description": "Flag for requires registration." }, "responsibilitySetRef": { "type": "string", "description": "Responsibility set reference." }, "serviceAccessRightRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" ] }, "groupOfSalesPackagesRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "allDistributionChannelsRef": { "type": "boolean", "description": "Flag for distribution in all channels." }, "groupOfDistributionChannelsRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "AccessRightInProductInsert": { "required": [ "fareFrameRef", "id", "preassignedFareProductRef", "validableElementRef" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:AccessRightInProduct:Ordinary" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "accessNumber": { "type": "integer", "description": "The actual access number", "format": "int32" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "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" }, "orderOfElement": { "type": "integer", "description": "The actual order in the sequence", "format": "int32" }, "isLastInSequence": { "type": "boolean", "description": "Whether element is last in sequence" }, "isFirstInSequence": { "type": "boolean", "description": "Whether element is first in sequence" }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessNumberIsLimited": { "type": "boolean", "description": "Flag indicating if access number is limited" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "preassignedFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "FareStructureElementInsert": { "required": [ "fareFrameRef", "fareTableRefs", "geographicalIntervalRefs", "id", "parameterAssignmentRefs" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareStructureElement:TENInterval" ] }, "name": { "type": "array", "description": "Name.", "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": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "tariffBasis": { "type": "string", "description": "Tariff basis.", "enum": [ "FLAT", "DISTANCE", "UNIT_SECTION", "ZONE", "ZONE_TO_ZONE", "POINT_TO_POINT", "ROUTE", "TOUR", "GROUP", "DISCOUNT", "PERIOD", "FREE", "OTHER" ], "examples": [ "DISTANCE" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareTableRefs": { "type": "array", "description": "fare table reference", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "pointToPointFareRefs": { "type": "array", "description": "Field is deprecated. Use 'geographical structure factor' instead to connect 'distance matrix elements' to 'fare structure element'", "deprecated": true, "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "parameterAssignmentRefs": { "type": "array", "description": "Access Right Parameter assignments.", "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", "examples": [ "NSB:GeographicalStructureFactor:TENPrices" ] }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] } } }, "GenericParameterAssignment": { "required": [ "changed", "created", "fareFrameRef", "id", "modification", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GenericParameterAssignment:AllowedOperators" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Status", "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime." }, "created": { "type": "string", "description": "Created datetime." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V2" ] }, "includes": { "type": "array", "description": "Includes genericParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignment" } }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "limitations": { "type": "array", "description": "Limitations as UsageParameters.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "nameOfClass": { "type": "string", "description": "Name of class", "examples": [ "GenericParameterAssignment" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "requiredType": { "type": "string", "description": "Required type.", "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" ], "examples": [ "SERVICE_JOURNEY_REF" ] }, "fareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "requiredElements": { "type": "array", "description": "Required elements.", "items": { "type": "string" } }, "chargingBasisType": { "type": "string", "description": "ChargingBasisType.", "enum": [ "FREE", "DISCOUNTED", "NORMAL", "ANY" ], "examples": [ "FREE" ] }, "requiredInContext": { "type": "string", "description": "Required in context.", "enum": [ "OFFERING", "BOOKING", "RESERVATION", "SALE", "FULFILMENT", "ACTIVATION", "CONSUMPTION", "REVALIDATION" ] }, "validityParameters": { "type": "array", "description": "Validity parameters as scoping validity parameters", "items": { "$ref": "#/components/schemas/ScopingValidityParameter" } }, "canIgnoreInOffering": { "type": "boolean", "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", "examples": [ true ] }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "includesGroupingType": { "type": "string", "description": "Includes grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "examples": [ "NSB:Version:V1" ] }, "limitationGroupingType": { "type": "string", "description": "Limitation grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "fareStructureElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef.", "examples": [ "NSB:Version:V1" ] }, "comparisonOperatorVariant": { "type": "string", "description": "Indicates whether a gpa belongs to A or E gpa implementation.", "examples": [ "A" ] }, "temporalValidityParameters": { "type": "array", "description": "Temporal validity parameter.", "items": { "$ref": "#/components/schemas/TemporalValidityParameter" } }, "typeOfAccessRightAssignment": { "$ref": "#/components/schemas/TypeOfAccessRightAssignment" }, "parentParameterAssignmentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityParameterGroupingType": { "type": "string", "description": "Validity parameter grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "validityParameterAssignmentType": { "type": "string", "description": "Validity parameter assignment type.", "enum": [ "EQ", "NE", "GT", "LT", "GE", "LE" ], "examples": [ "EQ" ] }, "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" ] } }, "description": "A GenericParameterAssignment" }, "GeographicalIntervalInsert": { "required": [ "fareFrameRef", "fareTableRefs", "id", "prices" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GeographicalInterval:1364TEN" ] }, "prices": { "type": "array", "description": "Prices for the fare.", "items": { "$ref": "#/components/schemas/FarePriceInsert" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version.", "examples": [ "NSB:Version:V1" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "intervalType": { "type": "string", "description": "IntervalType.", "enum": [ "STOP", "TARIFF_ZONE", "DISTANCE", "COUPON", "OTHER" ] }, "fareTableRefs": { "type": "array", "description": "Reference to fare table.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "numberOfUnits": { "type": "number", "description": "NumberOfUnits.", "format": "double" }, "endGeographicalValue": { "type": "integer", "description": "EndGeographicalValue.", "format": "int64" }, "startGeographicalValue": { "type": "integer", "description": "StartGeographicalValue.", "format": "int64" } } }, "TypeOfUsageParameterInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "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.", "examples": [ "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" } } }, "DistanceMatrixElementInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:DistanceMatrixElement:NSR167ToNSR359" ] }, "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" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "DistanceMatrixElement version.", "examples": [ "NSB:Version:V1" ] }, "distance": { "type": "number", "description": "Distance.", "format": "double", "examples": [ 16.4 ] }, "groupRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "isDirect": { "type": "boolean", "description": "Is a direct route.", "examples": [ true ] }, "tariffRef": { "$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" }, "fareTableRefs": { "type": "array", "description": "References to fare tables that provide prices or discounts for the user profile.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "endFareZoneRef": { "type": "string", "description": "End fare zone reference." }, "inverseAllowed": { "type": "boolean", "description": "Inverse is allowed.", "examples": [ true ] }, "endTariffZoneId": { "type": "string", "description": "End tariff zone reference. This field is deprecated, please use the field endFareZoneRef", "deprecated": true }, "limitingRuleRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "relativeRanking": { "type": "integer", "description": "Relative ranking.", "format": "int32", "examples": [ 2 ] }, "startFareZoneRef": { "type": "string", "description": "Start fare zone reference." }, "startTariffZoneId": { "type": "string", "description": "Start tariff zone reference. This field is deprecated, please use the field startFareZoneRef", "deprecated": true }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } }, "endScheduledStopPointId": { "type": "string", "description": "End scheduled stop point netexId." }, "startScheduledStopPointId": { "type": "string", "description": "Start scheduled stop point netexId." } }, "description": "A DistanceMatrixElement create request " }, "GeographicalStructureFactor": { "required": [ "changed", "created", "description", "distanceMatrixElements", "fareFrameRef", "geographicalIntervals", "id", "modification", "name", "nameOfClass", "status", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id", "examples": [ "NSB:GeographicalStructureFactor:50TEN" ] }, "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" } }, "status": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime", "readOnly": true }, "created": { "type": "string", "description": "Created datetime", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class", "readOnly": true, "examples": [ "GeographicalStructureFactor" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "geographicalUnitRef": { "type": "string", "description": "Geographical unit ref" }, "geographicalIntervals": { "type": "array", "description": "Geographical intervals", "items": { "$ref": "#/components/schemas/GeographicalInterval" } }, "distanceMatrixElements": { "type": "array", "description": "Distance matrix elements", "items": { "$ref": "#/components/schemas/DistanceMatrixElement" } } } }, "SeqExplainedMessageResponse": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } }, "description": "Translated messages explaining the failure", "readOnly": true }, "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": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment" ] }, "name": { "type": "array", "description": "Name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "status": { "type": "string", "description": "Type of access right assignment status.", "readOnly": true, "enum": [ "DRAFT", "PROPOSED", "VERSIONED", "DEPRECATED" ], "examples": [ "DRAFT" ] }, "changed": { "type": "string", "description": "Changed datetime.", "readOnly": true }, "created": { "type": "string", "description": "Created datetime.", "readOnly": true }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Type of access right assignment version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "readOnly": true, "examples": [ "TypeOfAccessRightAssignment" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "modification": { "type": "string", "description": "Modification status.", "readOnly": true, "enum": [ "NEW", "REVISE", "DELETE" ], "examples": [ "NEW" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." } }, "description": "A classification of Access Right Assignments." }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Number of the requested page. In case state is lost", "format": "int32", "examples": [ 1 ] } }, "description": "Validable Element Page Wrapper" }, "DistributionAssignmentInsert": { "required": [ "allDistributionChannelsRef", "distributionRights", "fareFrameRef", "id", "name", "organisationRef", "salesPackageRef", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:DistributionAssignment:Ordinary" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "paymentMethods": { "type": "array", "description": "Payment methods.", "items": { "type": "string" } }, "organisationRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "distributionRights": { "type": "string", "description": "Distribution rights.", "enum": [ "NONE", "SELL", "REFUND", "EXCHANGE", "INFROM", "PRIVATE", "OTHER" ], "examples": [ "SELL" ] }, "fulfilmentMethodRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "distributionChannelRef": { "type": "string", "description": "Distribution channel Ref." }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" }, "allDistributionChannelsRef": { "type": "boolean", "description": "Flag for distribution in all channels." }, "groupOfDistributionChannelsRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } } }, "PreassignedFareProductInsert": { "required": [ "chargingMomentRef", "fareFrameRef", "id", "name", "operatorRef", "organisation", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "RUT:PreassignedFareProduct:RuterSingleTicket" ] }, "name": { "type": "array", "description": "Name.", "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": "Version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "operatorRef": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "OperatorRef.", "examples": [ "RUT:Authority:RUT" ] }, "privateCode": { "type": "string", "description": "PrivateCode." }, "productType": { "type": "string", "description": "The type of fare product.", "enum": [ "SINGLE_TRIP" ], "examples": [ "SINGLE_TRIP" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "organisation": { "type": "string", "description": "Organisation." }, "fareTableRefs": { "type": "array", "description": "FareTableRef.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "conditionSummary": { "$ref": "#/components/schemas/ConditionSummaryInsert" }, "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" ] }, "chargingMomentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "fareStructureType": { "type": "string", "description": "FareStructureType.", "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" ], "examples": [ "ZONE_TO_ZONE_FARE" ] }, "chargingMomentType": { "type": "string", "description": "ChargingMomentType.", "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" ], "examples": [ "BEFORE_TRAVEL" ] }, "typeOfFareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "accessRightsInProduct": { "type": "array", "description": "AccessRightsInProduct.", "items": { "$ref": "#/components/schemas/AccessRightInProductInsert" } }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "compatibleWithVersionRef": { "type": "string", "description": "Compatible with version." }, "activeComparisonOperatorVariant": { "type": "string", "description": "Indicates whether A or E gpa implementation is active.", "examples": [ "A" ] }, "accessRightParameterAssignmentRefs": { "type": "array", "description": "AccessRightParameterAssignments.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } } } }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "readOnly": true, "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Number of the requested page. In case state is lost", "format": "int32", "readOnly": true, "examples": [ 13 ] } }, "description": "SaleDiscountRightPageWrapper" }, "SeqUVPForNumberOfZonesInsert": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "SeqUsageValidityPeriodInsert": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "GroupOfDistanceMatrixElements": { "required": [ "changed", "created", "fareFrameRef", "id", "membersId", "nameOfClass", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GroupOfDistanceMatrixElements:TENDistances" ] }, "name": { "type": "array", "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "GroupOfDistanceMatrixElements version.", "examples": [ "NSB:Version:V1" ] }, "tariffId": { "type": "integer", "description": "Tariff id.", "format": "int64" }, "membersId": { "type": "string", "description": "DistanceMatrixElements within the group." }, "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" }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "GroupOfDistanceMatrixElements" ] }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } } }, "description": "A GroupfOfDistanceMatrixElemenets" }, "ParameterPossibilitiesRequest": { "type": "object", "properties": { "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" } }, "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" } } }, "description": "Request for retrieving refunding alternatives for elements." }, "SeqGeographicalIntervalInsert": { "type": "object", "properties": { "empty": { "type": "boolean" }, "traversableAgain": { "type": "boolean" } } }, "FareStructureElementInSequence": { "required": [ "accessNumber", "changed", "created", "fareFrameRef", "fareStructureElementId", "fareStructureElementRef", "id", "nameOfClass", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareStructureElementInSequence:MiniPriceTENInterval" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "changed": { "type": "string", "description": "Changed datetime.", "format": "date-time" }, "created": { "type": "string", "description": "Created datetime.", "format": "date-time" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Fare structure element in sequence version.", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "nameOfClass": { "type": "string", "description": "Name of class.", "examples": [ "FareStructureElementInSequence" ] }, "accessNumber": { "type": "integer", "description": "The actual ordering in the sequence", "format": "int32" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "orderOfElement": { "type": "integer", "description": "Access quality structure factor refs", "format": "int32" }, "isLastInSequence": { "type": "boolean", "description": "Gives information if this sequence last or not" }, "isFirstInSequence": { "type": "boolean", "description": "Gives information if this sequence first or not" }, "limitedAccessNumber": { "type": "integer", "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", "format": "int32" }, "fareStructureElementId": { "type": "string", "description": "Fare structure element ref" }, "fareStructureElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A description of a fare structure element in sequence" }, "ScopingValidityParameterInsert": { "required": [ "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:ScopingValidityParameter:OperatorNSB" ] }, "changed": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "lineRef": { "type": "string", "description": "LineRef." }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "lineType": { "type": "string", "description": "LineType.", "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" ], "examples": [ "EXPRESS" ] }, "placeUse": { "type": "string", "description": "PlaceUse", "enum": [ "START_AT", "END_AT", "VIA", "RESTRICT_TO", "OTHER" ] }, "fareClasses": { "type": "array", "description": "Fare class list.", "items": { "type": "string" } }, "fareZoneRef": { "type": "string", "description": "FareZoneRef.", "examples": [ "KOL:FareZone:250" ] }, "nameOfClass": { "type": "string" }, "operatorRef": { "type": "string", "description": "Operator referance." }, "vehicleMode": { "type": "string", "description": "VehicleModeRef.", "enum": [ "AIR", "BUS", "COACH", "CABLE_WAY", "WATER", "FUNICULAR", "LIFT", "RAIL", "METRO", "TAXI", "TRAM", "UNKNOWN" ] }, "authorityRef": { "type": "string", "description": "AuthorityRef.", "examples": [ "NSB:Authority:NSB" ] }, "tariffZoneRef": { "type": "string", "description": "TariffZoneRef. This field is deprecated, please use the field FareZoneRef", "deprecated": true, "examples": [ "RUT:TariffZone:2S" ] }, "facilitySetRef": { "type": "string", "description": "facilitySetRef." }, "fareSectionRef": { "type": "string", "description": "Fare section ref." }, "groupOfLinesRef": { "type": "string", "description": "Group of lines ref.", "examples": [ "ENT:GroupOfLines:AllLines" ] }, "transportSubmode": { "type": "string", "description": "TransportSubmode.", "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" ], "examples": [ "expressBus" ] }, "topographicPlaceRef": { "type": "string", "description": "TopographicPlaceRef" }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version." }, "groupOfTariffZonesRef": { "type": "string", "description": "Group of Tariff Zones ref", "examples": [ "ENT:GroupOfTariffZones:AllZones" ] }, "scheduledStopPointRef": { "type": "string", "description": "Scheduled stop Point ref." }, "distributionChannelRef": { "type": "string", "description": "Reference to a DISTRIBUTION CHANNEL to which the ACCESS RIGHT PARAMETER ASSIGNMENTs applies.", "examples": [ "ENT:DistributionChannel:App" ] }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef" } }, "description": "A ScopingValidityParameter" }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Number of the requested page. In case state is lost", "format": "int32", "examples": [ 369 ] } }, "description": "FareTablePageWrapper" }, "TemporalValidityParameterInsert": { "required": [ "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:TemporalValidityParameter:OperatorNSB" ] }, "changed": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "dayType": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "nameOfClass": { "type": "string" }, "groupOfTimeBands": { "$ref": "#/components/schemas/GroupOfTimeBands" }, "validityCondition": { "$ref": "#/components/schemas/ValidityCondition" }, "validityConditionRef": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "description": "A TemporalValidityParameter" }, "GenericParameterAssignmentInsert": { "required": [ "fareFrameRef", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GenericParameterAssignment:AllowedOperators" ] }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V2" ] }, "includes": { "type": "array", "description": "Includes genericParameterAssignments.", "items": { "$ref": "#/components/schemas/GenericParameterAssignmentInsert" } }, "limitations": { "type": "array", "description": "Limitations as UsageParameters.", "items": { "$ref": "#/components/schemas/VersionOfObjectRef" } }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "requiredType": { "type": "string", "description": "Required type.", "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" ], "examples": [ "SERVICE_JOURNEY_REF" ] }, "fareProductRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "salesPackageRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "requiredElements": { "type": "string", "description": "Required elements.", "enum": [ "START_DATE", "START_TIME", "STANDARD_DURATION", "START_STOP_POINT_REF", "END_STOP_POINT_REF", "START_TARIFF_ZONE_REF", "END_TARIFF_ZONE_REF" ], "examples": [ "START_DATE" ] }, "chargingBasisType": { "type": "string", "description": "ChargingBasisType.", "enum": [ "FREE", "DISCOUNTED", "NORMAL", "ANY" ], "examples": [ "FREE" ] }, "requiredInContext": { "type": "string", "description": "Required in context.", "enum": [ "OFFERING", "BOOKING", "RESERVATION", "SALE", "FULFILMENT", "ACTIVATION", "CONSUMPTION", "REVALIDATION" ] }, "validityParameters": { "type": "array", "description": "Validity parameters as scoping validity parameters", "items": { "$ref": "#/components/schemas/ScopingValidityParameterInsert" } }, "canIgnoreInOffering": { "type": "boolean", "description": "Indicates whether gpa leaf node is supposed to be ignored when generating offer.", "examples": [ true ] }, "validableElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "includesGroupingType": { "type": "string", "description": "Includes grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "derivedFromVersionRef": { "type": "string", "description": "Derived from version.", "examples": [ "NSB:Version:V1" ] }, "limitationGroupingType": { "type": "string", "description": "Limitation grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "fareStructureElementRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "compatibleWithVersionRef": { "type": "string", "description": "CompatibleWithVersionRef.", "examples": [ "NSB:Version:V1" ] }, "comparisonOperatorVariant": { "type": "string", "description": "Indicates whether a gpa belongs to A or E gpa implementation.", "examples": [ "A" ] }, "temporalValidityParameters": { "type": "array", "description": "Temporal Validity parameter.", "items": { "$ref": "#/components/schemas/TemporalValidityParameterInsert" } }, "typeOfAccessRightAssignment": { "$ref": "#/components/schemas/TypeOfAccessRightAssignment" }, "parentParameterAssignmentRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "validityParameterGroupingType": { "type": "string", "description": "Validity parameter grouping type.", "enum": [ "AND", "OR", "XOR", "NOT" ], "examples": [ "AND" ] }, "validityParameterAssignmentType": { "type": "string", "description": "Validity parameter assignment type.", "enum": [ "EQ", "NE", "GT", "LT", "GE", "LE" ], "examples": [ "EQ" ] }, "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" ] } } }, "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" } }, "totalNumberOfItems": { "type": "integer", "description": "Total number of items.", "format": "int32", "examples": [ 369 ] }, "totalNumberOfPages": { "type": "integer", "description": "Number of pages needed to traverse all items.", "format": "int32", "readOnly": true, "examples": [ 15 ] }, "requestedPageNumber": { "type": "integer", "description": "Requested page number.", "format": "int32", "examples": [ 1 ] } }, "description": "PreassignedFareProductWrapper" }, "GroupOfDistanceMatrixElementsInsert": { "required": [ "fareFrameRef", "id", "members", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:GroupOfDistanceMatrixElements:TENDistances" ] }, "name": { "type": "array", "description": "GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "members": { "type": "array", "description": "DistanceMatrixElements within the group.", "items": { "type": "string" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "GroupOfDistanceMatrixElements version.", "examples": [ "NSB:Version:V1" ] }, "tariffId": { "type": "integer", "description": "Tariff id.", "format": "int64" }, "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" }, "validityConditions": { "type": "array", "description": "Validity conditions for the user profile.", "items": { "$ref": "#/components/schemas/ValidityCondition" } } }, "description": "A GroupDistanceMatrixElement create request" }, "FareStructureElementInSequenceInsert": { "required": [ "fareFrameRef", "fareStructureElementId", "id", "version" ], "type": "object", "properties": { "id": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Id.", "examples": [ "NSB:FareStructureElementInSequence:MiniPriceTENInterval" ] }, "name": { "type": "array", "description": "Name.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "version": { "minLength": 1, "pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$", "type": "string", "description": "Version", "examples": [ "NSB:Version:V1" ] }, "description": { "type": "array", "description": "Description.", "items": { "$ref": "#/components/schemas/TextInLanguage" } }, "accessNumber": { "type": "integer", "description": "The actual access number", "format": "int32" }, "fareFrameRef": { "$ref": "#/components/schemas/VersionOfObjectRef" }, "orderOfElement": { "type": "integer", "description": "Access quality structure factor refs", "format": "int32" }, "isLastInSequence": { "type": "boolean", "description": "Whether element is last in sequence" }, "isFirstInSequence": { "type": "boolean", "description": "Whether element is first in sequence" }, "limitedAccessNumber": { "type": "integer", "description": "Flag indicating whether this rights gives an unlimited number of accesses or not", "format": "int32" }, "fareStructureElementId": { "type": "string", "description": "Fare structure element id", "examples": [ "NSB:FareStructureElement:TENInterval" ] } } } }, "parameters": { "ET-Client-Name": { "in": "header", "name": "ET-Client-Name", "description": "\nEntur Client Header.\nIt is required that all consumers identify themselves by using this header.\nEntur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.\nThe structure of ET-Client-Name should be: `-` for companies, and `-` for individuals.", "schema": { "type": "string" } }, "X-Correlation-Id": { "in": "header", "name": "X-Correlation-Id", "description": "Correlation id", "schema": { "type": "string" } } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }