Entur Developer
Products
Products

service-facility-sets

Server
Download schema

Retrieves all service facility sets

GET
https://api.entur.io/products
/service-facility-sets

Retrieves all service facility sets › query Parameters

orgId
​string · style: form · explode: true
fareFrameId
​string · style: form · explode: true
minimizeDataLoad
​boolean · style: form · explode: true
validOnDate
​string · date-time · style: form · explode: true

Return only the versions valid on the given date (ISO-8601).

Retrieves all service facility sets › 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 service facility sets › Responses

Returns the info

A ServiceFacilitySet
ServiceFacilitySet
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

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

Id

Example: NSB:ServiceFacilitySet:Ordinary
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: ServiceFacilitySet
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
​Accommodation

An Accommodation

​TextInLanguage[]

Description

​TextInLanguage[]

Name

​OnboardStay

An OnboardStay

Create a ServiceFacilitySet

POST
https://api.entur.io/products
/service-facility-sets

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

A ServiceFacilitySet
ServiceFacilitySet
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

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

Id

Example: NSB:ServiceFacilitySet:Ordinary
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: ServiceFacilitySet
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
​Accommodation

An Accommodation

​TextInLanguage[]

Description

​TextInLanguage[]

Name

​OnboardStay

An OnboardStay

Create a ServiceFacilitySet › Responses

Entity created successfully

No data returned

Retrieves the service facility set valid on a given date

GET
https://api.entur.io/products
/service-facility-sets/{id}

Optional validOnDate query parameter (defaults to now). In prod returns the VERSIONED element; in staging/dev PROPOSED is preferred over VERSIONED.

Retrieves the service facility set valid on a given date › path Parameters

id
​string · required · style: simple

The id to identify a ServiceFacilitySet

Retrieves the service facility set valid on a given date › query Parameters

validOnDate
​string · date-time · style: form · explode: true

Return the version valid on the given date (ISO-8601).

Retrieves the service facility set valid on a given date › 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 the service facility set valid on a given date › Responses

Returns the info

A ServiceFacilitySet
ServiceFacilitySet
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

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

Id

Example: NSB:ServiceFacilitySet:Ordinary
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: ServiceFacilitySet
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
​Accommodation

An Accommodation

​TextInLanguage[]

Description

​TextInLanguage[]

Name

​OnboardStay

An OnboardStay

Retrieves service facility set for id and version

GET
https://api.entur.io/products
/service-facility-sets/{id}/{version}

Retrieves service facility set for id and version › path Parameters

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

The id to identify a ServiceFacilitySet

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

The id for the version of the ServiceFacilitySet

Retrieves service facility set 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 service facility set for id and version › Responses

Returns the info

A ServiceFacilitySet
ServiceFacilitySet
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

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

Id

Example: NSB:ServiceFacilitySet:Ordinary
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: ServiceFacilitySet
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
​Accommodation

An Accommodation

​TextInLanguage[]

Description

​TextInLanguage[]

Name

​OnboardStay

An OnboardStay

Updates an existing ServiceFacilitySet

PUT
https://api.entur.io/products
/service-facility-sets/{id}/{version}

Updates an existing ServiceFacilitySet › path Parameters

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

The id to identify a ServiceFacilitySet

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

The id for the version of the ServiceFacilitySet

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

A ServiceFacilitySet
ServiceFacilitySet
changed
​string · readOnly · required

Changed datetime

created
​string · readOnly · required

Created datetime

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

Id

Example: NSB:ServiceFacilitySet:Ordinary
modification
​string · enum · readOnly · required

Modification status

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

Name of class

Example: ServiceFacilitySet
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
​Accommodation

An Accommodation

​TextInLanguage[]

Description

​TextInLanguage[]

Name

​OnboardStay

An OnboardStay

Updates an existing ServiceFacilitySet › Responses

Entity updated successfully

No data returned

Deletes a ServiceFacilitySet by id and version

DELETE
https://api.entur.io/products
/service-facility-sets/{id}/{version}

Deletes a ServiceFacilitySet by id and version › path Parameters

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

The id to identify a ServiceFacilitySet

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

The id for the version of the ServiceFacilitySet

Deletes a ServiceFacilitySet 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 a ServiceFacilitySet by id and version › Responses

The resource was deleted

BoxedUnit
security-policytariffs
Did you find what you were looking for?