entitlement-products

Server

Download schema

Retrieves entitlement-products by organisation id and fare frame id

GET

https://api.entur.io/products

/entitlement-products

Retrieves entitlement-products by organisation id and fare frame id › 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 entitlement-products by organisation id and fare frame 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

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 entitlement-products by organisation id and fare frame id › Responses

Returns the info

EntitlementProduct[]

An ENTITLEMENT PRODUCT response.

EntitlementProduct

changed

string · required

Changed datetime.

created

string · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

string · required

Id.

Example: RUT:EntitlementProduct:PersonalTicket

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: EntitlementProduct

status

string · enum · required

Status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

ValidityCondition[] · required

ValidityCondition.

compatibleWithVersionRef

string

CompatibleWithVersionRef.

derivedFromVersionRef

string

Derived from version.

Description.

FareTableRef.

Fare frame ref.

Name.

organisation

string

Organisation who own the product.

privateCode

string

PrivateCode.

TypeOfFareProduct

A classification of FARE PRODUCTs.

version

string

Version.

Example: NSB:Version:V1

GET/entitlement-products

curl https://api.entur.io/products/entitlement-products

Example Responses

[
  {
    "changed": "changed",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "created",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "id": "RUT:EntitlementProduct:PersonalTicket",
    "limitingRuleRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "EntitlementProduct",
    "organisation": "organisation",
    "privateCode": "privateCode",
    "status": "DRAFT",
    "typeOfFareProduct": {
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:TypeOfFareProduct:Ordinary",
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "TypeOfFareProduct",
      "status": "DRAFT",
      "version": "NSB:Version:V1"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "version": "NSB:Version:V1"
  }
]

json

application/json

entitlement-given entitlements-required

Did you find what you were looking for?

entitlement-products

Retrieves entitlement-products by organisation id and fare frame id

Retrieves entitlement-products by organisation id and fare frame id › query Parameters

Retrieves entitlement-products by organisation id and fare frame id › Headers

Retrieves entitlement-products by organisation id and fare frame id › Responses

Build with Entur

Contribute

Terms & Policies