Retrieves all user 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
validOnDateReturn the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones
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 all user profile › 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… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
UserProfile Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices for the user profile.
proofOfIdentityproofOfIdentity.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
Create a userprofile
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 userprofile › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
proofOfIdentityproofOfIdentity.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion profiles describing users who may travel with user.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
Fare prices for the user profile.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
companionProfileIdsCompanion profiles describing users who may travel with user.
Create a userprofile › Responses
Entity created successfully
Retrieves a userprofile by id
path Parameters
idThe unique id to identify a userprofile
query Parameters
versionThe id for the version of the userprofile
languageCodeThe language code from ISO-639-3
validOnDateReturn the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that if this parameter is given, the version parameter is ignored.Also note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones
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 a userprofile 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… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
UserProfile Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices for the user profile.
proofOfIdentityproofOfIdentity.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
Retrives a userprofile by id and version
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a userprofile
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the userprofile
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>.
X-Correlation-IdCorrelation id
Accept-LanguageIf-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 userprofile by id and version › 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… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
UserProfile Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices for the user profile.
proofOfIdentityproofOfIdentity.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
Update a user profile
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe unique id to identify a userprofile
version^([A-Z]{3}):([A-Za-z… · required · style: simpleThe id for the version of the userprofile
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 user profile › Request Body
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
proofOfIdentityproofOfIdentity.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion profiles describing users who may travel with user.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
Fare prices for the user profile.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
companionProfileIdsCompanion profiles describing users who may travel with user.
Update a user profile › Responses
Entity updated successfully
Retrieves a user profile by id
path Parameters
idThe unique id to identify a user profile
query Parameters
languageCodestartDateendDatestatusThe version status of the user profile
validOnDateReturn the UserProfiles valid on this date, example: 2024-06-01T00:00:00Z. Note that if this parameter is given, the other parameters startDate, endDate and status are ignored. Only one UserProfile will be returned.Also note that, if called in the production environment, only VERSIONED UserProfiles are returned. And in the staging environment, PROPOSED UserProfiles are preferred to VERSIONED ones
fromDateThe from date of the user profiles version
toDateThe to date of the user 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>.
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 user profile 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… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
UserProfile Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices for the user profile.
proofOfIdentityproofOfIdentity.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.