type-of-usage-parameters

Server

Download schema

Retrieves all type of usage parameters.

GET

https://api.entur.io/products

/type-of-usage-parameters

Retrieves all type of usage parameters. › 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 identify dataset to an organization

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrieves all type of usage 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 type of usage parameters. › Responses

Returns the info

TypeOfUsageParameter

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfUsageParameter:abc123

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

status

string · enum · 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

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

GET/type-of-usage-parameters

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

Example Responses

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

json

application/json

Create type of usage parameter

POST

https://api.entur.io/products

/type-of-usage-parameters

Create type of usage parameter › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create type of usage parameter › Request Body

TypeOfUsageParameterInsert

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfUsageParameter:ThroughFareInterchanging

version

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

Version.

Example: NSB:Version:V1

TextInLanguage[]

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

TextInLanguage[]

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

Create type of usage parameter › Responses

Entity created successfully

No data returned

POST/type-of-usage-parameters

curl https://api.entur.io/products/type-of-usage-parameters \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfUsageParameter:ThroughFareInterchanging",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1"
}'

Example Request Body

{
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:TypeOfUsageParameter:ThroughFareInterchanging",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1"
}

json

Example Responses

No example specified for this content type

Retrieves type of usage parameter by id and version

GET

https://api.entur.io/products

/type-of-usage-parameters/{id}/{version}

Retrieves type of usage parameter by id and version › path Parameters

id

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

The unique id to identify a type of usage parameters

version

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

version

Retrieves type of usage parameter by id and version › Headers

ET-Client-Name

string · style: simple

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 type of usage parameter by id and version › Responses

Returns the info

TypeOfUsageParameter

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfUsageParameter:abc123

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

status

string · enum · 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

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

GET/type-of-usage-parameters/{id}/{version}

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

Example Responses

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

json

application/json

Retrieves type of usage parameter by id

GET

https://api.entur.io/products

/v1/type-of-usage-parameters/{id}

Retrieves type of usage parameter by id › path Parameters

id

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

The unique id to identify a type of usage parameters

Retrieves type of usage parameter 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 usage parameters

fromDate

string · style: form · explode: true

The from date of the type of usage parameters version

toDate

string · style: form · explode: true

The to date of the type of usage parameter version

Retrieves type of usage parameter by id › Headers

ET-Client-Name

string · style: simple

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 type of usage parameter by id › Responses

Returns the info

TypeOfUsageParameter[]

TypeOfUsageParameter

changed

string · date-time · required

Changed datetime.

compatibleWithVersionRef

string · required

Compatible with version.

created

string · date-time · required

Created datetime.

VersionOfObjectRef · required

Fare frame ref.

id

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

Id.

Example: NSB:TypeOfUsageParameter:abc123

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: TypeOfUsageParameter

status

string · enum · 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

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

TextInLanguage[]

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

GET/v1/type-of-usage-parameters/{id}

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

Example Responses

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

json

application/json

type-of-responsibility-role usage-validity-periods

Did you find what you were looking for?

type-of-usage-parameters

Retrieves all type of usage parameters.

Retrieves all type of usage parameters. › query Parameters

Retrieves all type of usage parameters. › Headers

Retrieves all type of usage parameters. › Responses

Create type of usage parameter

Create type of usage parameter › Headers

Create type of usage parameter › Request Body

Create type of usage parameter › Responses

Retrieves type of usage parameter by id and version

Retrieves type of usage parameter by id and version › path Parameters

Retrieves type of usage parameter by id and version › Headers

Retrieves type of usage parameter by id and version › Responses

Retrieves type of usage parameter by id

Retrieves type of usage parameter by id › path Parameters

Retrieves type of usage parameter by id › query Parameters

Retrieves type of usage parameter by id › Headers

Retrieves type of usage parameter by id › Responses

Build with Entur

Contribute

Terms & Policies