Retrieves generic parameter assignment by fare frame id or organisation
query Parameters
orgIdThe unique id to identify the data owner.
fareFrameIdThe unique id to identify the data set to an organisation
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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>.
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 generic parameter assignment by fare frame id or organisation › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignment (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
Create a generic parameter assignment
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>.
X-Correlation-IdCorrelation id
Create a generic parameter assignment › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignmentInsert (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal Validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
Create a generic parameter assignment › Responses
Entity created successfully
Create many generic parameter assignments
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>.
X-Correlation-IdCorrelation id
Create many generic parameter assignments › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignmentInsert (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal Validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
Create many generic parameter assignments › Responses
Entities created successfully
Retrives a generic parameter assignment by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a generic parameter assignment
query Parameters
versionThe id for the version of the generic parameter assignment
languageCodeThe language code from ISO-639-3
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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>.
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.
Retrives a generic parameter assignment by id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignment (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
Retrives a generic parameter assignment by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a generic parameter assignment
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the generic parameter assignment
query Parameters
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
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>.
X-Correlation-IdCorrelation id
Accept-LanguageThe language code from ISO-639-3
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.
Retrives a generic parameter assignment by id and version › Responses
Returns the info
Update a generic parameter assignment
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a generic parameter assignment
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the generic parameter assignment
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>.
X-Correlation-IdCorrelation id
Update a generic parameter assignment › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignmentInsert (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal Validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
Update a generic parameter assignment › Responses
Entity updated successfully
Retrieves a generic parameter assignment by id
path Parameters
idThe unique id to identify a generic parameter assignment
query Parameters
startDateendDatestatusThe version status of the generic parameter assignment
gpaDataSetDeprecated: this parameter is ignored. Only E-variant GPAs are returned.
fromDateThe from date of the generic parameter assignments version
toDateThe to date of the generic parameter assignments version
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>.
X-Correlation-IdCorrelation id
LanguagecodeAccept-LanguageThe language code from ISO-639-3
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 a generic parameter assignment by id › Responses
Returns the info
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare frame ref.
includesGenericParameterAssignment (circular)Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters