Entur Developer
Products
Products

entitlement-given

Server
Download schema

Retrieves all entitlement given

GET
https://api.entur.io/products
/entitlement-given

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

Returns the info

EntitlementGiven
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

entitlementType
​string · enum · required

Entitlement type

Enum values:
USE
PURCHASE
PURCHASE_AT_DISCOUNT
NONE
​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement given represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementGiven
​FarePrice[] · required

Prices for the entitlement given.

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

Version

Example: NSB:Version:V1
​EntitlementConstraint · readOnly

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.

minimumQualificationPeriod
​string

Minimum qualification period

Example: 01:59:59.999999999
​VersionOfObjectRef

Fare frame ref.

Create a EntitlementGiven

POST
https://api.entur.io/products
/entitlement-given

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

EntitlementGiven
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

entitlementType
​string · enum · required

Entitlement type

Enum values:
USE
PURCHASE
PURCHASE_AT_DISCOUNT
NONE
​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement given represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementGiven
​FarePrice[] · required

Prices for the entitlement given.

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

Version

Example: NSB:Version:V1
​EntitlementConstraint · readOnly

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.

minimumQualificationPeriod
​string

Minimum qualification period

Example: 01:59:59.999999999
​VersionOfObjectRef

Fare frame ref.

Create a EntitlementGiven › Responses

Entity created successfully

No data returned

Retrieves entitlement given for id and version

GET
https://api.entur.io/products
/entitlement-given/{id}/{version}

Retrieves entitlement given for id and version › path Parameters

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

The id to identify a EntitlementGiven

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

The id for the version of the EntitlementGiven

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

Returns the info

EntitlementGiven
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

entitlementType
​string · enum · required

Entitlement type

Enum values:
USE
PURCHASE
PURCHASE_AT_DISCOUNT
NONE
​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement given represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementGiven
​FarePrice[] · required

Prices for the entitlement given.

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

Version

Example: NSB:Version:V1
​EntitlementConstraint · readOnly

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.

minimumQualificationPeriod
​string

Minimum qualification period

Example: 01:59:59.999999999
​VersionOfObjectRef

Fare frame ref.

Updates an existing EntitlementGiven

PUT
https://api.entur.io/products
/entitlement-given/{id}/{version}

Updates an existing EntitlementGiven › path Parameters

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

The id to identify a EntitlementGiven

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

The id for the version of the EntitlementGiven

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

EntitlementGiven
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

entitlementType
​string · enum · required

Entitlement type

Enum values:
USE
PURCHASE
PURCHASE_AT_DISCOUNT
NONE
​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:EntitlementGiven:TrondelagCustomerCard
modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
​TextInLanguage[] · required

The name of the entitlement given represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: EntitlementGiven
​FarePrice[] · required

Prices for the entitlement given.

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

Version

Example: NSB:Version:V1
​EntitlementConstraint · readOnly

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.

minimumQualificationPeriod
​string

Minimum qualification period

Example: 01:59:59.999999999
​VersionOfObjectRef

Fare frame ref.

Updates an existing EntitlementGiven › Responses

Entity updated successfully

No data returned

Deletes an entitlement given by id and version

DELETE
https://api.entur.io/products
/entitlement-given/{id}/{version}

Deletes an entitlement given by id and version › path Parameters

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

The id to identify an entitlement given

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

The id for the version of the entitlement given

Deletes an entitlement given by 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

Deletes an entitlement given by id and version › Responses

The resource was deleted

BoxedUnit
distribution-channel-usagesentitlement-products
Did you find what you were looking for?