Entur Developer
Products

reverting

Server

Retrieves all reverting parameters

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

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

Returns the info

​Reverting[]
Reverting
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

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

Reverting status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1
allowedAfterControl
​boolean

Specifies if revert is allowed after control.

Example: true
Default: false
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

maximumTimeAfterUse
​string

Maximum time after use Represented as a string formatted according to ISO-8601

Example: PT1H
minimumTimeAfterUse
​string

Minimum time after use. Represented as a string formatted according to ISO-8601

Example: PT1H
​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the reverting rule.

​VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Create a Reverting

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

Create a Reverting › 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 Reverting › Request Body

Reverting
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

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

Reverting status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1
allowedAfterControl
​boolean

Specifies if revert is allowed after control.

Example: true
Default: false
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

maximumTimeAfterUse
​string

Maximum time after use Represented as a string formatted according to ISO-8601

Example: PT1H
minimumTimeAfterUse
​string

Minimum time after use. Represented as a string formatted according to ISO-8601

Example: PT1H
​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the reverting rule.

​VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Create a Reverting › Responses

Entity created successfully

No data returned

Retrieves reverting for id and version

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

Retrieves reverting for id and version › path Parameters

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

The id to identify a Reverting

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

The id for the version of the Reverting

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

Returns the info

Reverting
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

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

Reverting status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1
allowedAfterControl
​boolean

Specifies if revert is allowed after control.

Example: true
Default: false
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

maximumTimeAfterUse
​string

Maximum time after use Represented as a string formatted according to ISO-8601

Example: PT1H
minimumTimeAfterUse
​string

Minimum time after use. Represented as a string formatted according to ISO-8601

Example: PT1H
​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the reverting rule.

​VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Updates an existing Reverting

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

Updates an existing Reverting › path Parameters

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

The id to identify a Reverting

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

The id for the version of the Reverting

Updates an existing Reverting › 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 Reverting › Request Body

Reverting
changed
​string · readOnly · required

Changed datetime.

created
​string · readOnly · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

id
​string · minLength: 1 · required

Id.

Example: NSB:Reverting:SelfService
modification
​string · enum · readOnly · required

Modification status.

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

Name of class.

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

Reverting status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · required

Reverting version.

Example: NSB:Version:V1
allowedAfterControl
​boolean

Specifies if revert is allowed after control.

Example: true
Default: false
compatibleWithVersionRef
​string · readOnly

Compatible with version.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

​VersionOfObjectRef[]

References for associated fare tables.

maximumTimeAfterUse
​string

Maximum time after use Represented as a string formatted according to ISO-8601

Example: PT1H
minimumTimeAfterUse
​string

Minimum time after use. Represented as a string formatted according to ISO-8601

Example: PT1H
​TextInLanguage[]

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

​FarePrice[]

Prices in different currencies for the reverting rule.

​VersionOfObjectRef

Fare frame ref.

typeOfUsageParameter
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Updates an existing Reverting › Responses

Entity updated successfully

No data returned

Did you find what you were looking for?