Entur Developer
Products
Products

luggage-allowances

Server
Download schema

Retrieves all luggage allowances

GET
https://api.entur.io/products
/luggage-allowances

Retrieves all luggage allowances › 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

Retrieves all luggage allowances › 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 luggage allowances › Responses

Returns the info

LuggageAllowance
LuggageAllowance
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:LuggageAllowance:Bicycle
modification
​string · enum · readOnly · required

Modification status

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

The name of the luggage allowance represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: LuggageAllowance
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1
baggageType
​string · enum

Baggage Type

Enum values:
HANDBAG
HAND_LUGGAGE
SMALL_SUITCASE
SUITCASE
TRUNK
OVERSIZE_ITEM
BICYCLE
SPORTING_EQUIPMENT
baggageUseType
​string · enum

Baggage Use Type

Enum values:
CARRY_ON
CHECK_IN
OVERSIZE_CHECK_IN
luggageAllowanceType
​string · enum

Luggage Allowance Type

Enum values:
NONE
UNLIMITED
SINGLE
LIMITED
luggageChargingBasis
​string · enum

Luggage Charging Basis

Enum values:
FREE
CHARGED_BY_ITEM
CHARGED_BY_WEIGHT
OTHER
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Prices for the luggage allowance.

Create a luggage allowance

POST
https://api.entur.io/products
/luggage-allowances

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

LuggageAllowance
LuggageAllowance
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:LuggageAllowance:Bicycle
modification
​string · enum · readOnly · required

Modification status

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

The name of the luggage allowance represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: LuggageAllowance
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1
baggageType
​string · enum

Baggage Type

Enum values:
HANDBAG
HAND_LUGGAGE
SMALL_SUITCASE
SUITCASE
TRUNK
OVERSIZE_ITEM
BICYCLE
SPORTING_EQUIPMENT
baggageUseType
​string · enum

Baggage Use Type

Enum values:
CARRY_ON
CHECK_IN
OVERSIZE_CHECK_IN
luggageAllowanceType
​string · enum

Luggage Allowance Type

Enum values:
NONE
UNLIMITED
SINGLE
LIMITED
luggageChargingBasis
​string · enum

Luggage Charging Basis

Enum values:
FREE
CHARGED_BY_ITEM
CHARGED_BY_WEIGHT
OTHER
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Prices for the luggage allowance.

Create a luggage allowance › Responses

Entity created successfully

No data returned

Retrieves luggage allowance versions for a given id

GET
https://api.entur.io/products
/luggage-allowances/{id}/versions

Retrieves luggage allowance versions for a given id › path Parameters

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

The id to identify a LuggageAllowance

Retrieves luggage allowance versions for a given id › query Parameters

active
​boolean · style: form · explode: true

If value is set to true only active versions will be returned, otherwise all versions will be returned

Retrieves luggage allowance versions for a given id › 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 luggage allowance versions for a given id › Responses

Returns the info

LuggageAllowance
LuggageAllowance
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:LuggageAllowance:Bicycle
modification
​string · enum · readOnly · required

Modification status

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

The name of the luggage allowance represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: LuggageAllowance
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1
baggageType
​string · enum

Baggage Type

Enum values:
HANDBAG
HAND_LUGGAGE
SMALL_SUITCASE
SUITCASE
TRUNK
OVERSIZE_ITEM
BICYCLE
SPORTING_EQUIPMENT
baggageUseType
​string · enum

Baggage Use Type

Enum values:
CARRY_ON
CHECK_IN
OVERSIZE_CHECK_IN
luggageAllowanceType
​string · enum

Luggage Allowance Type

Enum values:
NONE
UNLIMITED
SINGLE
LIMITED
luggageChargingBasis
​string · enum

Luggage Charging Basis

Enum values:
FREE
CHARGED_BY_ITEM
CHARGED_BY_WEIGHT
OTHER
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Prices for the luggage allowance.

Retrieves luggage allowance for id and version

GET
https://api.entur.io/products
/luggage-allowances/{id}/{version}

Retrieves luggage allowance for id and version › path Parameters

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

The id to identify a LuggageAllowance

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

The id for the version of the LuggageAllowance

Retrieves luggage allowance 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 luggage allowance for id and version › Responses

Returns the info

LuggageAllowance
LuggageAllowance
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:LuggageAllowance:Bicycle
modification
​string · enum · readOnly · required

Modification status

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

The name of the luggage allowance represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: LuggageAllowance
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1
baggageType
​string · enum

Baggage Type

Enum values:
HANDBAG
HAND_LUGGAGE
SMALL_SUITCASE
SUITCASE
TRUNK
OVERSIZE_ITEM
BICYCLE
SPORTING_EQUIPMENT
baggageUseType
​string · enum

Baggage Use Type

Enum values:
CARRY_ON
CHECK_IN
OVERSIZE_CHECK_IN
luggageAllowanceType
​string · enum

Luggage Allowance Type

Enum values:
NONE
UNLIMITED
SINGLE
LIMITED
luggageChargingBasis
​string · enum

Luggage Charging Basis

Enum values:
FREE
CHARGED_BY_ITEM
CHARGED_BY_WEIGHT
OTHER
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Prices for the luggage allowance.

Updates an existing LuggageAllowance

PUT
https://api.entur.io/products
/luggage-allowances/{id}/{version}

Updates an existing LuggageAllowance › path Parameters

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

The id to identify a LuggageAllowance

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

The id for the version of the LuggageAllowance

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

LuggageAllowance
LuggageAllowance
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​TextInLanguage[] · required

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

​VersionOfObjectRef · required

Fare frame ref.

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

Id

Example: NSB:LuggageAllowance:Bicycle
modification
​string · enum · readOnly · required

Modification status

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

The name of the luggage allowance represented in different languages. Language codes are ISO-639

nameOfClass
​string · readOnly · required

Name of class

Example: LuggageAllowance
status
​string · enum · readOnly · required

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Version

Example: NSB:Version:V1
baggageType
​string · enum

Baggage Type

Enum values:
HANDBAG
HAND_LUGGAGE
SMALL_SUITCASE
SUITCASE
TRUNK
OVERSIZE_ITEM
BICYCLE
SPORTING_EQUIPMENT
baggageUseType
​string · enum

Baggage Use Type

Enum values:
CARRY_ON
CHECK_IN
OVERSIZE_CHECK_IN
luggageAllowanceType
​string · enum

Luggage Allowance Type

Enum values:
NONE
UNLIMITED
SINGLE
LIMITED
luggageChargingBasis
​string · enum

Luggage Charging Basis

Enum values:
FREE
CHARGED_BY_ITEM
CHARGED_BY_WEIGHT
OTHER
organisationId
​string

Organisation related to the userProfile

​FarePrice[]

Prices for the luggage allowance.

Updates an existing LuggageAllowance › Responses

Entity updated successfully

No data returned

Delete an existing LuggageAllowance

DELETE
https://api.entur.io/products
/luggage-allowances/{id}/{version}

Delete an existing LuggageAllowance › path Parameters

id
​string · required · style: simple

The id to identify a LuggageAllowance

version
​string · required · style: simple

The id for the version of the LuggageAllowance

Delete an existing LuggageAllowance › 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

Delete an existing LuggageAllowance › Responses

Entity deleted successfully

No data returned
journey-patternsmeta-data
Did you find what you were looking for?