type-of-fare-products

Server

Download schema

Retrieves type of fare products by organisationId or fareFrameId

GET

https://api.entur.io/products

/type-of-fare-products

Retrieves type of fare products by organisationId or fareFrameId › query Parameters

orgId

string · style: form · explode: true

The unique id to identify a organisation

fareFrameId

string · style: form · explode: true

The unique id to identify dataset to an organization

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrieves type of fare products by organisationId or fareFrameId › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves type of fare products by organisationId or fareFrameId › Responses

Returns the info

A classification of FARE PRODUCTs.

TypeOfFareProduct

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of fare product version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Type of fare product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Create type of fare product

POST

https://api.entur.io/products

/type-of-fare-products

Create type of fare product › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create type of fare product › Request Body

TypeOfFareProductInsert

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Type of fare product version.

Example: NSB:Version:V1

Create type of fare product › Responses

Entity created successfully

No data returned

POST/type-of-fare-products

curl https://api.entur.io/products/type-of-fare-products \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfFareProduct:Ordinary",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfFareProduct:Ordinary",
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves type of fare product by id

GET

https://api.entur.io/products

/type-of-fare-products/{id}

Retrieves type of fare product by id › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a type of fare product

Retrieves type of fare product by id › query Parameters

version

string · style: form · explode: true

version

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrieves type of fare product by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves type of fare product by id › Responses

Returns the info

A classification of FARE PRODUCTs.

TypeOfFareProduct

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of fare product version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Type of fare product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Retrieves type of fare product by id

GET

https://api.entur.io/products

/type-of-fare-products/{id}/{version}

Retrieves type of fare product by id › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a type of fare product

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

version

Retrieves type of fare product by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

The language code from ISO-639-3

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves type of fare product by id › Responses

Returns the info

A classification of FARE PRODUCTs.

TypeOfFareProduct

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of fare product version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Type of fare product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

Update a type of fare product

PUT

https://api.entur.io/products

/type-of-fare-products/{id}/{version}

Update a type of fare product › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a type of fare product

version

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

version

Update a type of fare product › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update a type of fare product › Request Body

TypeOfFareProductInsert

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z…

Type of fare product version.

Example: NSB:Version:V1

Update a type of fare product › Responses

Entity updated successfully

No data returned

PUT/type-of-fare-products/{id}/{version}

curl https://api.entur.io/products/type-of-fare-products/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfFareProduct:Ordinary",
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "compatibleWithVersionRef": "compatibleWithVersionRef",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfFareProduct:Ordinary",
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves type of fare product by id

GET

https://api.entur.io/products

/v1/type-of-fare-products/{id}

Retrieves type of fare product by id › path Parameters

id

string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a type of fare product

Retrieves type of fare product by id › query Parameters

startDate

string · style: form · explode: true

endDate

string · style: form · explode: true

status

string · style: form · explode: true

The version status of the type of fare product

fromDate

string · style: form · explode: true

The from date of the type of fare products version

toDate

string · style: form · explode: true

The to date of the type of fare products version

Retrieves type of fare product by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

The language code from ISO-639-3

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves type of fare product by id › Responses

Returns the info

TypeOfFareProduct[]

A classification of FARE PRODUCTs.

TypeOfFareProduct

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:TypeOfFareProduct:Ordinary

nameOfClass

string · readOnly · required

Name of class.

Example: TypeOfFareProduct

version

string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Type of fare product version.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

modification

string · enum · readOnly

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

status

string · enum · readOnly

Type of fare product status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

GET/v1/type-of-fare-products/{id}

curl https://api.entur.io/products/v1/type-of-fare-products/:id

Example Responses

[
  {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:TypeOfFareProduct:Ordinary",
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "TypeOfFareProduct",
    "status": "DRAFT",
    "version": "NSB:Version:V1"
  }
]

json

application/json

type-of-concession type-of-responsibility-role

Did you find what you were looking for?

type-of-fare-products

Retrieves type of fare products by organisationId or fareFrameId

Retrieves type of fare products by organisationId or fareFrameId › query Parameters

Retrieves type of fare products by organisationId or fareFrameId › Headers

Retrieves type of fare products by organisationId or fareFrameId › Responses

Create type of fare product

Create type of fare product › Headers

Create type of fare product › Request Body

Create type of fare product › Responses

Retrieves type of fare product by id

Retrieves type of fare product by id › path Parameters

Retrieves type of fare product by id › query Parameters

Retrieves type of fare product by id › Headers

Retrieves type of fare product by id › Responses

Retrieves type of fare product by id

Retrieves type of fare product by id › path Parameters

Retrieves type of fare product by id › Headers

Retrieves type of fare product by id › Responses

Update a type of fare product

Update a type of fare product › path Parameters

Update a type of fare product › Headers

Update a type of fare product › Request Body

Update a type of fare product › Responses

Retrieves type of fare product by id

Retrieves type of fare product by id › path Parameters

Retrieves type of fare product by id › query Parameters

Retrieves type of fare product by id › Headers

Retrieves type of fare product by id › Responses

Build with Entur

Contribute

Terms & Policies