Entur Developer
Products
Products

transferabilities

Server
Download schema

Retrieves all transferabilities

GET
https://api.entur.io/products
/transferabilities

Retrieves all transferabilities › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify an organisation

fareFrameId
​string · style: form · explode: true

The unique id to identify a dataset to an organisation

minimizeDataLoad
​boolean · style: form · explode: true

Retrieves all transferabilities › 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 all transferabilities › Responses

Returns the info

Transferability
Transferability
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:Transferability:NoTransfer
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class.

Example: Transferability
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Transferability version.

Example: NSB:Version:V1
canTransfer
​boolean

Whether ticket can be transferred to someone else.

Example: false
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

hasTransferFee
​boolean

Whether there is a charge for making a transfer.

Example: false
maximumNumberOfNamedUsers
​integer · int32

Where a product can be used by a limited number of named users, maximum number of users allowed..

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the transferability rule.

Create a transferability

POST
https://api.entur.io/products
/transferabilities

Create a transferability › 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

Create a transferability › Request Body

Transferability
Transferability
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:Transferability:NoTransfer
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class.

Example: Transferability
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Transferability version.

Example: NSB:Version:V1
canTransfer
​boolean

Whether ticket can be transferred to someone else.

Example: false
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

hasTransferFee
​boolean

Whether there is a charge for making a transfer.

Example: false
maximumNumberOfNamedUsers
​integer · int32

Where a product can be used by a limited number of named users, maximum number of users allowed..

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the transferability rule.

Create a transferability › Responses

Entity created successfully

No data returned

Retrieves transferabilities for id and version

GET
https://api.entur.io/products
/transferabilities/{id}/{version}

Retrieves transferabilities for id and version › path Parameters

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

The id to identify a Transferability

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

The id for the version of the Transferability

Retrieves transferabilities for id and version › 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 transferabilities for id and version › Responses

Returns the info

Transferability
Transferability
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:Transferability:NoTransfer
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class.

Example: Transferability
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Transferability version.

Example: NSB:Version:V1
canTransfer
​boolean

Whether ticket can be transferred to someone else.

Example: false
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

hasTransferFee
​boolean

Whether there is a charge for making a transfer.

Example: false
maximumNumberOfNamedUsers
​integer · int32

Where a product can be used by a limited number of named users, maximum number of users allowed..

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the transferability rule.

Updates an existing Transferability

PUT
https://api.entur.io/products
/transferabilities/{id}/{version}

Updates an existing Transferability › path Parameters

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

The id to identify a Transferability

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

The id for the version of the Transferability

Updates an existing Transferability › 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

Updates an existing Transferability › Request Body

Transferability
Transferability
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:Transferability:NoTransfer
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class.

Example: Transferability
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Transferability version.

Example: NSB:Version:V1
canTransfer
​boolean

Whether ticket can be transferred to someone else.

Example: false
​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

hasTransferFee
​boolean

Whether there is a charge for making a transfer.

Example: false
maximumNumberOfNamedUsers
​integer · int32

Where a product can be used by a limited number of named users, maximum number of users allowed..

​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the transferability rule.

Updates an existing Transferability › Responses

Entity updated successfully

No data returned
timebandstransferability-possibilities
Did you find what you were looking for?