Entur Developer
Products
Products

period-tickets

Server
Download schema

Retrieves a period tickets and its userprofiles and usage validity periods by authority

GET
https://api.entur.io/products
/period-tickets

Retrieves a period tickets and its userprofiles and usage validity periods by authority › query Parameters

orgId
​string · style: form · explode: true

The unique id to identify a organisation

fareFrameId
​string · style: form · explode: true

The unique id to idetify data owned by organisation

Retrieves a period tickets and its userprofiles and usage validity periods by authority › 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

Accept-Language
​string · style: simple

The language code from ISO-639-3

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 a period tickets and its userprofiles and usage validity periods by authority › Responses

Returns the info

PeriodTicket with userprofiles and usage validity periods
PeriodTicketInfo
id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: RUT:PreassignedFareProduct:30Days
​VersionOfObjectRef[]

Limitations as UsageParameters.

operatorRef
​string

OperatorRef.

Example: RUT:Authority:RUT
organisation
​string

Organisation who own the product.

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

Version.

Example: NSB:Version:V1
penalty-policy-possibilitiespreassigned-products
Did you find what you were looking for?