Entur Developer
Products
Products

availability-conditions

Server
Download schema

Retrieves all availability condition parameters

GET
https://api.entur.io/products
/availability-conditions

Retrieves all availability condition parameters › 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 availability condition parameters › 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 availability condition parameters › Responses

Returns the info

An AvailabilityCondition
AvailabilityCondition
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

fromDate
​string · required

FromDate datetime.

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

Id.

Example: ENT:AvailabilityCondition:SomeId
isAvailable
​boolean · required

Is available

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

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

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
toDate
​string · required

toDate datetime.

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

AvailabilityCondition version.

Example: ENT:Version:SomeVersion
available
​boolean
​VersionOfObjectRef[]

Day Type references.

​TextInLanguage[]

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

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​VersionOfObjectRef[]

Time band references.

Create a Availability Condition

POST
https://api.entur.io/products
/availability-conditions

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

An AvailabilityCondition
AvailabilityCondition
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

fromDate
​string · required

FromDate datetime.

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

Id.

Example: ENT:AvailabilityCondition:SomeId
isAvailable
​boolean · required

Is available

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

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

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
toDate
​string · required

toDate datetime.

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

AvailabilityCondition version.

Example: ENT:Version:SomeVersion
available
​boolean
​VersionOfObjectRef[]

Day Type references.

​TextInLanguage[]

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

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​VersionOfObjectRef[]

Time band references.

Create a Availability Condition › Responses

Entity created successfully

No data returned

Retrieves Availability Condition for id and version

GET
https://api.entur.io/products
/availability-conditions/{id}/{version}

Retrieves Availability Condition for id and version › path Parameters

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

The id to identify a Availability Condition

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

The id for the version of the Availability Condition

Retrieves Availability Condition 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 Availability Condition for id and version › Responses

Returns the info

An AvailabilityCondition
AvailabilityCondition
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

fromDate
​string · required

FromDate datetime.

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

Id.

Example: ENT:AvailabilityCondition:SomeId
isAvailable
​boolean · required

Is available

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

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

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
toDate
​string · required

toDate datetime.

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

AvailabilityCondition version.

Example: ENT:Version:SomeVersion
available
​boolean
​VersionOfObjectRef[]

Day Type references.

​TextInLanguage[]

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

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​VersionOfObjectRef[]

Time band references.

Updates an existing Availability Condition

PUT
https://api.entur.io/products
/availability-conditions/{id}/{version}

Updates an existing Availability Condition › path Parameters

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

The id to identify a Availability Condition

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

The id for the version of the Availability Condition

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

An AvailabilityCondition
AvailabilityCondition
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

​VersionOfObjectRef · required

Fare frame ref.

fromDate
​string · required

FromDate datetime.

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

Id.

Example: ENT:AvailabilityCondition:SomeId
isAvailable
​boolean · required

Is available

modification
​string · enum · readOnly · required

Modification status

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · readOnly · required

Name of class

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

Status

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
toDate
​string · required

toDate datetime.

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

AvailabilityCondition version.

Example: ENT:Version:SomeVersion
available
​boolean
​VersionOfObjectRef[]

Day Type references.

​TextInLanguage[]

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

​TextInLanguage[]

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

organisationId
​string

Organisation related to the userProfile

​VersionOfObjectRef[]

Time band references.

Updates an existing Availability Condition › Responses

Entity updated successfully

No data returned

Deletes an AvailabilityCondition by id and version

DELETE
https://api.entur.io/products
/availability-conditions/{id}/{version}

Deletes an AvailabilityCondition by id and version › path Parameters

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

The id to identify a Availability Condition

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

The id for the version of the Availability Condition

Deletes an AvailabilityCondition 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 an AvailabilityCondition by id and version › Responses

The resource was deleted

No data returned
amount-of-price-unit-productscapped-discount-rights
Did you find what you were looking for?