Entur Developer
Products
Products

penalty Policy

Server
Download schema

Retrieves all penaltyPolicy parameters

GET
https://api.entur.io/products
/penalty-policies

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

Returns the info

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

POST
https://api.entur.io/products
/penalty-policies

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

Request Body

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

Responses

Entity created successfully

No data returned

Retrieves penalty policy for id and version

GET
https://api.entur.io/products
/penalty-policies/{id}/{version}

Retrieves penalty policy for id and version › path Parameters

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

The id to identify a PenaltyPolicy

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

The id for the version of the PenaltyPolicy

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

Returns the info

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

Updates an existing PenaltyPolicy

PUT
https://api.entur.io/products
/penalty-policies/{id}/{version}

Updates an existing PenaltyPolicy › path Parameters

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

The id to identify a PenaltyPolicy

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

The id for the version of the PenaltyPolicy

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

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

Updates an existing PenaltyPolicy › Responses

Entity updated successfully

No data returned

Deletes an penalty policy by id and version

DELETE
https://api.entur.io/products
/penalty-policies/{id}/{version}

Deletes an penalty policy by id and version › path Parameters

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

The id to identify an penalty policy

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

The id for the version of the penalty policy

Deletes an penalty policy 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 penalty policy by id and version › Responses

The resource was deleted

BoxedUnit
parameter-usagespenalty-policy-possibilities
Did you find what you were looking for?