Retrieves all penaltyPolicy parameters
query Parameters
orgIdThe unique id to identify an organisation
fareFrameIdThe unique id to identify a dataset to an organisation
minimizeDataLoadHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged
createdCreated
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassNameOfClass
modificationModification status.
References for associated fare tables.
Name.
Prices in different currencies for the penalty policy.
Description.
Fare frame ref.
A LimitingRule
paymentMethodPaymentMethod
penaltyActionPenaltyAction
Fare frame ref.
penaltyPolicyTypePenaltyPolicyType
derivedFromVersionRefDerived from version.
typeOfUsageParameterReftypeOfUsageParameter.
compatibleWithVersionRefCompatibleWithVersionRef
minimumTimeBeforeReentryMinimumTimeBeforeReentry
sameStationReentryPolicyTypeSameStationReentryPolicyType
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged
createdCreated
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassNameOfClass
modificationModification status.
References for associated fare tables.
Name.
Prices in different currencies for the penalty policy.
Description.
Fare frame ref.
A LimitingRule
paymentMethodPaymentMethod
penaltyActionPenaltyAction
Fare frame ref.
penaltyPolicyTypePenaltyPolicyType
derivedFromVersionRefDerived from version.
typeOfUsageParameterReftypeOfUsageParameter.
compatibleWithVersionRefCompatibleWithVersionRef
minimumTimeBeforeReentryMinimumTimeBeforeReentry
sameStationReentryPolicyTypeSameStationReentryPolicyType
Responses
Entity created successfully
Retrieves penalty policy for id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a PenaltyPolicy
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the PenaltyPolicy
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
If-None-MatchUsed 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
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged
createdCreated
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassNameOfClass
modificationModification status.
References for associated fare tables.
Name.
Prices in different currencies for the penalty policy.
Description.
Fare frame ref.
A LimitingRule
paymentMethodPaymentMethod
penaltyActionPenaltyAction
Fare frame ref.
penaltyPolicyTypePenaltyPolicyType
derivedFromVersionRefDerived from version.
typeOfUsageParameterReftypeOfUsageParameter.
compatibleWithVersionRefCompatibleWithVersionRef
minimumTimeBeforeReentryMinimumTimeBeforeReentry
sameStationReentryPolicyTypeSameStationReentryPolicyType
Updates an existing PenaltyPolicy
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify a PenaltyPolicy
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the PenaltyPolicy
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Updates an existing PenaltyPolicy › Request Body
id^([A-Z]{3}):([A-Za-z… · requiredId
statusStatus
changedChanged
createdCreated
version^([A-Z]{3}):([A-Za-z… · requiredVersion
nameOfClassNameOfClass
modificationModification status.
References for associated fare tables.
Name.
Prices in different currencies for the penalty policy.
Description.
Fare frame ref.
A LimitingRule
paymentMethodPaymentMethod
penaltyActionPenaltyAction
Fare frame ref.
penaltyPolicyTypePenaltyPolicyType
derivedFromVersionRefDerived from version.
typeOfUsageParameterReftypeOfUsageParameter.
compatibleWithVersionRefCompatibleWithVersionRef
minimumTimeBeforeReentryMinimumTimeBeforeReentry
sameStationReentryPolicyTypeSameStationReentryPolicyType
Updates an existing PenaltyPolicy › Responses
Entity updated successfully
Deletes an penalty policy by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id to identify an penalty policy
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the penalty policy
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Deletes an penalty policy by id and version › Responses
The resource was deleted