type-of-concession

Server

Download schema

Retrieves typeOfConcession by fareframe id or organisation id

GET

https://api.entur.io/products

/type-of-concession

Retrieves typeOfConcession by fareframe id or organisation id › 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 fareframe

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrieves typeOfConcession by fareframe id or organisation id › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

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 typeOfConcession by fareframe id or organisation id › Responses

Returns the info

TypeOfConcession[]

A TypeOfConcession

TypeOfConcession

id

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

Id.

Example: NSB:TypeOfConcession:Student

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

TypeOfConcession version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

TypeOfConcession name represented in different languages. Language codes are ISO-639.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

organisationId

string

Organisation related to the userProfile

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

GET/type-of-concession

curl https://api.entur.io/products/type-of-concession

Example Responses

[
  {
    "id": "NSB:TypeOfConcession:Student",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "2024-08-25T15:00:00Z",
    "created": "2024-08-25T15:00:00Z",
    "version": "NSB:Version:V1",
    "infolink": "infolink",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "TypeOfConcession",
    "privateCode": "privateCode",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisationId": "organisationId",
    "alternativeNames": "alternativeNames",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "compatibleWithVersionRef": "compatibleWithVersionRef"
  }
]

json

application/json

Retrives a typeOfConcession by id

GET

https://api.entur.io/products

/type-of-concession/{id}

Retrives a typeOfConcession by id › path Parameters

id

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

The unique id to identify a typeOfConcession

Retrives a typeOfConcession by id › query Parameters

version

string · style: form · explode: true

The id for the version of the typeOfConcession

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrives a typeOfConcession by id › Headers

ET-Client-Name

string

X-Correlation-Id

string

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.

Retrives a typeOfConcession by id › Responses

Returns the info

A TypeOfConcession

TypeOfConcession

id

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

Id.

Example: NSB:TypeOfConcession:Student

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

TypeOfConcession version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

TypeOfConcession name represented in different languages. Language codes are ISO-639.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

organisationId

string

Organisation related to the userProfile

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

GET/type-of-concession/{id}

curl https://api.entur.io/products/type-of-concession/:id

Example Responses

{
  "id": "NSB:TypeOfConcession:Student",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "version": "NSB:Version:V1",
  "infolink": "infolink",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "TypeOfConcession",
  "privateCode": "privateCode",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "alternativeNames": "alternativeNames",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

application/json

Retrives a type of concession by id

GET

https://api.entur.io/products

/v1/type-of-concession/{id}

Retrives a type of concession by id › path Parameters

id

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

The unique id to identify a type of concession

Retrives a type of concession by id › query Parameters

startDate

string · style: form · explode: true

endDate

string · style: form · explode: true

status

string · style: form · explode: true

The version status of the type of concession

fromDate

string · style: form · explode: true

The from date of the type of concessions version

toDate

string · style: form · explode: true

The to date of the type of concessions version

Retrives a type of concession by id › Headers

ET-Client-Name

string

X-Correlation-Id

string

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.

Retrives a type of concession by id › Responses

Returns the info

TypeOfConcession[]

A TypeOfConcession

TypeOfConcession

id

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

Id.

Example: NSB:TypeOfConcession:Student

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

TypeOfConcession version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

TypeOfConcession name represented in different languages. Language codes are ISO-639.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

organisationId

string

Organisation related to the userProfile

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

GET/v1/type-of-concession/{id}

curl https://api.entur.io/products/v1/type-of-concession/:id

Example Responses

[
  {
    "id": "NSB:TypeOfConcession:Student",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "2024-08-25T15:00:00Z",
    "created": "2024-08-25T15:00:00Z",
    "version": "NSB:Version:V1",
    "infolink": "infolink",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "TypeOfConcession",
    "privateCode": "privateCode",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisationId": "organisationId",
    "alternativeNames": "alternativeNames",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "compatibleWithVersionRef": "compatibleWithVersionRef"
  }
]

json

application/json

Retrives a typeOfConcession by id and version

GET

https://api.entur.io/products

/type-of-concession/{id}/{version}

Retrives a typeOfConcession by id and version › path Parameters

id

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

The unique id to identify a typeOfConcession

version

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

The id for the version of the typeOfConcession

Retrives a typeOfConcession by id and version › Headers

ET-Client-Name

string

X-Correlation-Id

string

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.

Retrives a typeOfConcession by id and version › Responses

Returns the info

A TypeOfConcession

TypeOfConcession

id

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

Id.

Example: NSB:TypeOfConcession:Student

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · date-time · required

Changed datetime.

created

string · date-time · required

Created datetime.

version

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

TypeOfConcession version.

Example: NSB:Version:V1

nameOfClass

string · required

Name of class.

Example: TypeOfConcession

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

compatibleWithVersionRef

string · required

Compatible with version.

TextInLanguage[]

TypeOfConcession name represented in different languages. Language codes are ISO-639.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

organisationId

string

Organisation related to the userProfile

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

GET/type-of-concession/{id}/{version}

curl https://api.entur.io/products/type-of-concession/:id/:version

Example Responses

{
  "id": "NSB:TypeOfConcession:Student",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "status": "DRAFT",
  "changed": "2024-08-25T15:00:00Z",
  "created": "2024-08-25T15:00:00Z",
  "version": "NSB:Version:V1",
  "infolink": "infolink",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "TypeOfConcession",
  "privateCode": "privateCode",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "modification": "NEW",
  "organisationId": "organisationId",
  "alternativeNames": "alternativeNames",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

application/json

Update a type of concession

PUT

https://api.entur.io/products

/type-of-concession/{id}/{version}

Update a type of concession › path Parameters

id

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

The unique id to identify a typeOfConcession

version

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

The id for the version of the typeOfConcession

Update a type of concession › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update a type of concession › Request Body

A TypeOfConcession

TypeOfConcessionInsert

id

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

Example: NSB:TypeOfConcession:Student

TextInLanguage[] · required

TypeOfConcession name represented in different languages. Language codes are ISO-639.

version

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

TypeOfConcession version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

infolink

string

An URL to more info about the type of concession

TextInLanguage[]

TypeOfConcession description represented in different languages. Language codes are ISO-639.

privateCode

string

A code to support interoperability with legacy systems

alternativeNames

string

Alternative names for the type of concession

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Update a type of concession › Responses

Entity updated successfully

No data returned

PUT/type-of-concession/{id}/{version}

curl https://api.entur.io/products/type-of-concession/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:TypeOfConcession:Student",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "infolink": "infolink",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "privateCode": "privateCode",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "alternativeNames": "alternativeNames",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}'

Example Request Body

{
  "id": "NSB:TypeOfConcession:Student",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "infolink": "infolink",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "privateCode": "privateCode",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "alternativeNames": "alternativeNames",
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

Example Responses

No example specified for this content type

luggage-allowances validable-elements

Build with Entur

Contribute

Terms & Policies

type-of-concession

Retrieves typeOfConcession by fareframe id or organisation id

Retrieves typeOfConcession by fareframe id or organisation id › query Parameters

Retrieves typeOfConcession by fareframe id or organisation id › Headers

Retrieves typeOfConcession by fareframe id or organisation id › Responses

Retrives a typeOfConcession by id

Retrives a typeOfConcession by id › path Parameters

Retrives a typeOfConcession by id › query Parameters

Retrives a typeOfConcession by id › Headers

Retrives a typeOfConcession by id › Responses

Retrives a type of concession by id

Retrives a type of concession by id › path Parameters

Retrives a type of concession by id › query Parameters

Retrives a type of concession by id › Headers

Retrives a type of concession by id › Responses

Retrives a typeOfConcession by id and version

Retrives a typeOfConcession by id and version › path Parameters

Retrives a typeOfConcession by id and version › Headers

Retrives a typeOfConcession by id and version › Responses

Update a type of concession

Update a type of concession › path Parameters

Update a type of concession › Headers

Update a type of concession › Request Body

Update a type of concession › Responses