Entur Developer
Products
Products

penalty-policy-possibilities

Server
Download schema

Retrieves penalty policy rules for given elements

POST
https://api.entur.io/products
/penalty-policy-possibilities

Retrieves penalty policy rules for given elements › 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

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

Retrieves penalty policy rules for given elements › Request Body

Request for retrieving refunding alternatives for elements.
ParameterPossibilitiesRequest
​IdAndVersion[]

Fare structure elements the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Preassigned products the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Sales packages the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Validable elements the user wants to retrieve the parameter alternatives for.

Retrieves penalty policy rules for given elements › Responses

Returns the resource.

Penalty policy alternatives for an element.
PenaltyPolicyAlternatives
​PenaltyPolicy[] · required

Penalty policy alternatives for this element.

​IdAndVersion · required

Describes the ID and version of an element.

Retrieves penalty policy rules for given elements

GET
https://api.entur.io/products
/penalty-policy-possibilities/fare-structure-element/{id}/{version}

Retrieves penalty policy rules for given elements › path Parameters

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

The id to identify a fare structure element.

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

The version of the element.

Retrieves penalty policy rules for given elements › 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

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

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 penalty policy rules for given elements › Responses

Returns the resource.

A PENALTY POLICY
PenaltyPolicy
changed
​string · readOnly · required

Changed

created
​string · readOnly · required

Created

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung
modification
​string · enum · readOnly · required

Modification status.

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

NameOfClass

Example: PenaltyPolicy
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
compatibleWithVersionRef
​string

CompatibleWithVersionRef

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

​VersionOfObjectRef

Fare frame ref.

​LimitingRule

A LimitingRule

​VersionOfObjectRef

Fare frame ref.

minimumTimeBeforeReentry
​string

MinimumTimeBeforeReentry

Example: PT24H
​TextInLanguage[]

Name.

paymentMethod
​string

PaymentMethod

Example: CASH
penaltyAction
​string

PenaltyAction

Example: FINE
penaltyPolicyType
​string

PenaltyPolicyType

Example: NO_TICKET
​FarePrice[]

Prices in different currencies for the penalty policy.

sameStationReentryPolicyType
​string

SameStationReentryPolicyType

Example: BLOCKED
typeOfUsageParameterRef
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Retrieves penalty policy rules for given elements

GET
https://api.entur.io/products
/penalty-policy-possibilities/preassigned-product/{id}/{version}

Retrieves penalty policy rules for given elements › path Parameters

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

The id to identify a product.

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

The version of the element.

Retrieves penalty policy rules for given elements › 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

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

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 penalty policy rules for given elements › Responses

Returns the resource.

A PENALTY POLICY
PenaltyPolicy
changed
​string · readOnly · required

Changed

created
​string · readOnly · required

Created

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung
modification
​string · enum · readOnly · required

Modification status.

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

NameOfClass

Example: PenaltyPolicy
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
compatibleWithVersionRef
​string

CompatibleWithVersionRef

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

​VersionOfObjectRef

Fare frame ref.

​LimitingRule

A LimitingRule

​VersionOfObjectRef

Fare frame ref.

minimumTimeBeforeReentry
​string

MinimumTimeBeforeReentry

Example: PT24H
​TextInLanguage[]

Name.

paymentMethod
​string

PaymentMethod

Example: CASH
penaltyAction
​string

PenaltyAction

Example: FINE
penaltyPolicyType
​string

PenaltyPolicyType

Example: NO_TICKET
​FarePrice[]

Prices in different currencies for the penalty policy.

sameStationReentryPolicyType
​string

SameStationReentryPolicyType

Example: BLOCKED
typeOfUsageParameterRef
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Retrieves penalty policy rules for given elements

GET
https://api.entur.io/products
/penalty-policy-possibilities/sales-package/{id}/{version}

Retrieves penalty policy rules for given elements › path Parameters

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

The unique id to identify a sales package.

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

The version of the element.

Retrieves penalty policy rules for given elements › 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

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

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 penalty policy rules for given elements › Responses

Returns the resource.

A PENALTY POLICY
PenaltyPolicy
changed
​string · readOnly · required

Changed

created
​string · readOnly · required

Created

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung
modification
​string · enum · readOnly · required

Modification status.

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

NameOfClass

Example: PenaltyPolicy
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
compatibleWithVersionRef
​string

CompatibleWithVersionRef

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

​VersionOfObjectRef

Fare frame ref.

​LimitingRule

A LimitingRule

​VersionOfObjectRef

Fare frame ref.

minimumTimeBeforeReentry
​string

MinimumTimeBeforeReentry

Example: PT24H
​TextInLanguage[]

Name.

paymentMethod
​string

PaymentMethod

Example: CASH
penaltyAction
​string

PenaltyAction

Example: FINE
penaltyPolicyType
​string

PenaltyPolicyType

Example: NO_TICKET
​FarePrice[]

Prices in different currencies for the penalty policy.

sameStationReentryPolicyType
​string

SameStationReentryPolicyType

Example: BLOCKED
typeOfUsageParameterRef
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating

Retrieves penalty policy rules for given elements

GET
https://api.entur.io/products
/penalty-policy-possibilities/validable-element/{id}/{version}

Retrieves penalty policy rules for given elements › path Parameters

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

The id to identify a validable element.

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

The version of the element.

Retrieves penalty policy rules for given elements › 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

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

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 penalty policy rules for given elements › Responses

Returns the resource.

A PENALTY POLICY
PenaltyPolicy
changed
​string · readOnly · required

Changed

created
​string · readOnly · required

Created

​VersionOfObjectRef[] · required

References for associated fare tables.

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

Id

Example: NSB:PenaltyPolicy:InspectionFeeYoung
modification
​string · enum · readOnly · required

Modification status.

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

NameOfClass

Example: PenaltyPolicy
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
compatibleWithVersionRef
​string

CompatibleWithVersionRef

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description.

​VersionOfObjectRef

Fare frame ref.

​LimitingRule

A LimitingRule

​VersionOfObjectRef

Fare frame ref.

minimumTimeBeforeReentry
​string

MinimumTimeBeforeReentry

Example: PT24H
​TextInLanguage[]

Name.

paymentMethod
​string

PaymentMethod

Example: CASH
penaltyAction
​string

PenaltyAction

Example: FINE
penaltyPolicyType
​string

PenaltyPolicyType

Example: NO_TICKET
​FarePrice[]

Prices in different currencies for the penalty policy.

sameStationReentryPolicyType
​string

SameStationReentryPolicyType

Example: BLOCKED
typeOfUsageParameterRef
​string

typeOfUsageParameter.

Example: ENT:TypeOfUsageParameter:OpenSeating
penalty Policyperiod-tickets
Did you find what you were looking for?