Retrieves all companion profile
query Parameters
orgIdThe unique id to identify a organisation
fareFrameIdThe unique id to identify dataset to an organization
languageCodeThe language code from ISO-639-3
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 all companion profile › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the companion profile.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
The name of the companion profile represented in different languages. Language codes are ISO-639.
Fare prices for the companion profile.
Fare frame ref.
Description represented in different languages. Language codes are ISO-639.
discountBasisBasis for discount.
References to fare tables that provide prices or discounts for the companion profile.
userProfileIdA user profile defining a category of people eligible to be a companion.
Fare frame ref.
Fare frame ref.
Validity conditions for the companion profile.
typeOfUsageParametertypeOfUsageParameter.
derivedFromVersionRefDerived from version.
Fare frame ref.
maximumNumberOfPersonsMaximum number of allowed companions.
minimumNumberOfPersonsMinimum number of allowed companions.
compatibleWithVersionRefCompatible with version.
ticketingThe type of way that tickets are issued to the group.
Retrieves a companion profile by id
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a companion profile
query Parameters
startDateendDatestatusThe version status of the companion profile
fromDateThe from date of the companion profiles version
toDateThe to date of the companion profiles 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> for companies, and <personal name>-<application> for individuals.
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.
Retrieves a companion profile by id › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the companion profile.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
The name of the companion profile represented in different languages. Language codes are ISO-639.
Fare prices for the companion profile.
Fare frame ref.
Description represented in different languages. Language codes are ISO-639.
discountBasisBasis for discount.
References to fare tables that provide prices or discounts for the companion profile.
userProfileIdA user profile defining a category of people eligible to be a companion.
Fare frame ref.
Fare frame ref.
Validity conditions for the companion profile.
typeOfUsageParametertypeOfUsageParameter.
derivedFromVersionRefDerived from version.
Fare frame ref.
maximumNumberOfPersonsMaximum number of allowed companions.
minimumNumberOfPersonsMinimum number of allowed companions.
compatibleWithVersionRefCompatible with version.
ticketingThe type of way that tickets are issued to the group.
Retrives a companion profile by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a companion profile
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the companion profile
query Parameters
languageCodeThe language code from ISO-639-3
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.
Retrives a companion profile by id and version › Responses
Returns the info
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus
changedChanged datetime.
createdCreated datetime.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the companion profile.
nameOfClassName of class.
Fare frame ref.
modificationModification status.
The name of the companion profile represented in different languages. Language codes are ISO-639.
Fare prices for the companion profile.
Fare frame ref.
Description represented in different languages. Language codes are ISO-639.
discountBasisBasis for discount.
References to fare tables that provide prices or discounts for the companion profile.
userProfileIdA user profile defining a category of people eligible to be a companion.
Fare frame ref.
Fare frame ref.
Validity conditions for the companion profile.
typeOfUsageParametertypeOfUsageParameter.
derivedFromVersionRefDerived from version.
Fare frame ref.
maximumNumberOfPersonsMaximum number of allowed companions.
minimumNumberOfPersonsMinimum number of allowed companions.
compatibleWithVersionRefCompatible with version.
ticketingThe type of way that tickets are issued to the group.