Entur Developer
Products
Products

sale-discount-rights

Server
Download schema

Retrieves all sale discount rights

GET
https://api.entur.io/products
/sale-discount-rights

Retrieves all sale discount rights › 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

Possibility of opting out of including child elements

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Return the SaleDiscountRights valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SaleDiscountRights are returned. And in the staging environment, PROPOSED SaleDiscountRights are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieves all sale discount rights › 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 sale discount rights › Responses

Returns the info

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Create a SaleDiscountRight

POST
https://api.entur.io/products
/sale-discount-rights

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

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Create a SaleDiscountRight › Responses

Entity created successfully

No data returned

Retrieves the number of sale discount rights

GET
https://api.entur.io/products
/sale-discount-rights/count

Retrieves the number of sale discount rights › 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

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Count SaleDiscountRights valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SaleDiscountRights are counted. And in the staging environment, PROPOSED SaleDiscountRights are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieves the number of sale discount rights › 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 the number of sale discount rights › Responses

Returns the info

​Count[]
Count
Count
numberOfElements
​integer · int32 · required

number of elements

Example: 369

Retrieves sale discount rights by id of the entitlement given they are connected to

GET
https://api.entur.io/products
/sale-discount-rights/entitlement-given/{id}

Retrieves sale discount rights by id of the entitlement given they are connected to › path Parameters

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

The id to identify an EntitlementGiven

Retrieves sale discount rights by id of the entitlement given they are connected to › query Parameters

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves sale discount rights by id of the entitlement given they are connected to › 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 sale discount rights by id of the entitlement given they are connected to › Responses

Returns the info

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported

GET
https://api.entur.io/products
/sale-discount-rights/pages

Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported › 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

Possibility of opting out of including child elements

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

pageSize
​integer · int32 · style: form · explode: true

Size of page

pageNumber
​integer · int32 · style: form · explode: true

Page number

statusFilter
​string[] · style: form · explode: true

Filter by status. Allowed values: DRAFT, PROPOSED, VERSIONED, DEPRECATED, ALL. Defaults to ALL if not specified. Mutually exclusive with validOnDate.

validOnDate
​string · style: form · explode: true

Return the SaleDiscountRights valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED SaleDiscountRights are returned. And in the staging environment, PROPOSED SaleDiscountRights are preferred to VERSIONED ones. Mutually exclusive with statusFilter.

Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported › 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.

Retrieve sale discount rights for a given page. Limiting selection by fareFrameId and orgId parameter is supported › Responses

Returns the info

SaleDiscountRightPageWrapper
SaleDiscountRightPageWrapper
​SeqSaleDiscountRight[] · readOnly · required

SaleDiscountRights for the given page

requestedPageNumber
​integer · int32 · readOnly · required

Number of the requested page. In case state is lost

Example: 13
totalNumberOfItems
​integer · int32 · readOnly · required

Total number of items.

Example: 369
totalNumberOfPages
​integer · int32 · readOnly · required

Number of pages needed to traverse all items.

Example: 15

Retrieves a sale discount right by id. When 'validOnDate' is omitted, returns the version valid today.

GET
https://api.entur.io/products
/sale-discount-rights/{id}

Retrieves a sale discount right by id. When 'validOnDate' is omitted, returns the version valid today. › path Parameters

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

The id to identify a SaleDiscountRight

Retrieves a sale discount right by id. When 'validOnDate' is omitted, returns the version valid today. › query Parameters

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

validOnDate
​string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601). In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieves a sale discount right by id. When 'validOnDate' is omitted, returns the version valid today. › 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 a sale discount right by id. When 'validOnDate' is omitted, returns the version valid today. › Responses

Returns the info

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Retrieves sale discount right for id and version

GET
https://api.entur.io/products
/sale-discount-rights/{id}/{version}

Retrieves sale discount right for id and version › path Parameters

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

The id to identify a SaleDiscountRight

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

The id for the version of the SaleDiscountRight

Retrieves sale discount right for id and version › query Parameters

gpaDataSet
​string · style: form · explode: true

Deprecated: this parameter is ignored. Only E-variant GPAs are returned.

Retrieves sale discount right 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 sale discount right for id and version › Responses

Returns the info

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Updates an existing SaleDiscountRight

PUT
https://api.entur.io/products
/sale-discount-rights/{id}/{version}

Updates an existing SaleDiscountRight › path Parameters

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

The id to identify a SaleDiscountRight

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

The id for the version of the SaleDiscountRight

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

A Sale Discount Right response
SaleDiscountRight
​GenericParameterAssignment[] · required

AccessRightParameterAssignments.

​AccessRightInProduct[] · required

AccessRightsInProduct.

changed
​string · readOnly · required

SalesPackage changed datetime.

created
​string · readOnly · required

SalesPackage create datetime.

​VersionOfObjectRef · required

Fare frame ref.

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket
modification
​string · enum · readOnly · required

Modification status.

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

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

nameOfClass
​string · readOnly · required

Name of class.

Example: PreassignedFareProduct
organisation
​string · required

Organisation who own the product.

​FarePrice[] · required

Prices for the sdr.

status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
​ValidityCondition[] · required

ValidityCondition.

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

Version

Example: NSB:Version:V1
activeComparisonOperatorVariant
​string

Deprecated: this parameter will be ignored

Example: E
chargingMomentType
​string · enum

ChargingMomentType. Default value is BEFORE_TRAVEL.

Enum values:
BEFORE_TRAVEL
ON_START_OF_TRAVEL
BEFORE_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_TRAVEL
ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY
ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD
AT_END_OF_TRAVEL
AT_END_OF_CHARGE_PERIOD
Example: BEFORE_TRAVEL
compatibleWithVersionRef
​string · readOnly

CompatibleWithVersionRef

​ConditionSummary

A summary of a condition.

derivedFromVersionRef
​string · readOnly

Derived from version.

​TextInLanguage[]

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

fareStructureType
​string · enum

FareStructureType.

Enum values:
CAPPED_FLAT_FARE
CAPPED_POINT_TO_POINT_FARE
CAPPED_ZONAL_FARE
LINE_FLAT_FARE
NETWORK_FLAT_FARE
POINT_TO_POINT_FARE
POINT_TO_POINT_DISTANCE_FARE
STAGE_FARE
Example: ZONE_TO_ZONE_FARE
​VersionOfObjectRef[]

FareTableRef.

​VersionOfObjectRef

Fare frame ref.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisationId
​string

Organisation related to the userProfile

privateCode
​string

PrivateCode.

​TypeOfFareProduct

A classification of FARE PRODUCTs.

​VersionOfObjectRef

Fare frame ref.

validationRequirements
​string[]

An optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED

Updates an existing SaleDiscountRight › Responses

Entity updated successfully

No data returned

Deletes a SaleDiscountRight by id and version

DELETE
https://api.entur.io/products
/sale-discount-rights/{id}/{version}

Deletes a SaleDiscountRight by id and version › path Parameters

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

The id to identify a SaleDiscountRight

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

The id for the version of the SaleDiscountRight

Deletes a SaleDiscountRight 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 a SaleDiscountRight by id and version › Responses

The resource was deleted

BoxedUnit
roundingssales-packages
Did you find what you were looking for?