Usage Validity Period

Server

Manage UsageValidityPeriod instances. Defines how long a product is valid after purchase or activation (e.g., single trip, 60 minutes, 30 days).

List usage validity period instances

GET

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period

Returns a paginated list of all UsageValidityPeriod instances.

List usage validity period instances › query Parameters

page

integer · min: 0 · style: form · explode: true

Zero-based page number. Defaults to 0.

Default: 0

size

integer · min: 1 · max: 1000 · style: form · explode: true

Number of instances per page. Defaults to 100.

Default: 100

List usage validity period instances › 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

List usage validity period instances › Responses

Paginated list of UsageValidityPeriod instances

UsageValidityPeriodListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

UsageValidityPeriod[] · required

totalCount

integer · required

Total number of UsageValidityPeriod instances.

Example: 8

Create a usage validity period instance

POST

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period

Create a new UsageValidityPeriod instance.

Create a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create a usage validity period instance › Request Body

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Create a usage validity period instance › Responses

UsageValidityPeriod instance created successfully

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

POST/v3/parameters/limitations/usage-validity-period

curl https://api.entur.io/products/v3/parameters/limitations/usage-validity-period \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}'

Example Request Body

{
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}

json

application/json

Example Responses

{
  "id": "ENT:UsageValidityPeriod:DuringTravel",
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}

json

application/json

Get a usage validity period instance

GET

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period/{id}

Retrieve the full detail of a single UsageValidityPeriod instance.

Get a usage validity period instance › path Parameters

id

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

The netex ID of the element to retrieve

Get a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Get a usage validity period instance › Responses

UsageValidityPeriod instance found

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Update a usage validity period instance

PUT

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period/{id}

Update an existing UsageValidityPeriod instance.

Update a usage validity period instance › path Parameters

id

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

The netex ID of the element to retrieve

Update a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update a usage validity period instance › Request Body

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Update a usage validity period instance › Responses

UsageValidityPeriod instance updated successfully

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

PUT/v3/parameters/limitations/usage-validity-period/{id}

curl https://api.entur.io/products/v3/parameters/limitations/usage-validity-period/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}'

Example Request Body

{
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}

json

application/json

Example Responses

{
  "id": "ENT:UsageValidityPeriod:DuringTravel",
  "name": [
    {
      "lang": "nb-NO",
      "value": "Under reise"
    }
  ],
  "activationType": "ON_CHECK_IN",
  "validityPeriod": "PT60M",
  "usageValidityType": "SINGLE_TRIP"
}

json

application/json

Sales package Version

List usage validity period instances

GET

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period

Returns a paginated list of all UsageValidityPeriod instances.

List usage validity period instances › query Parameters

page

integer · min: 0 · style: form · explode: true

Zero-based page number. Defaults to 0.

Default: 0

size

integer · min: 1 · max: 1000 · style: form · explode: true

Number of instances per page. Defaults to 100.

Default: 100

List usage validity period instances › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

List usage validity period instances › Responses

Paginated list of UsageValidityPeriod instances

UsageValidityPeriodListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

UsageValidityPeriod[] · required

totalCount

integer · required

Total number of UsageValidityPeriod instances.

Example: 8

Create a usage validity period instance

POST

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period

Create a new UsageValidityPeriod instance.

Create a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create a usage validity period instance › Request Body

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Create a usage validity period instance › Responses

UsageValidityPeriod instance created successfully

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Get a usage validity period instance

GET

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period/{id}

Retrieve the full detail of a single UsageValidityPeriod instance.

Get a usage validity period instance › path Parameters

id

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

The netex ID of the element to retrieve

Get a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Get a usage validity period instance › Responses

UsageValidityPeriod instance found

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Update a usage validity period instance

PUT

https://api.entur.io/products

/v3/parameters/limitations/usage-validity-period/{id}

Update an existing UsageValidityPeriod instance.

Update a usage validity period instance › path Parameters

id

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

The netex ID of the element to retrieve

Update a usage validity period instance › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update a usage validity period instance › Request Body

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Update a usage validity period instance › Responses

UsageValidityPeriod instance updated successfully

UsageValidityPeriod

id

string · pattern: ^([A-Z]{3}):UsageVal… · required

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

Usage Validity Period

List usage validity period instances

List usage validity period instances › query Parameters

List usage validity period instances › Headers

List usage validity period instances › Responses

Create a usage validity period instance

Create a usage validity period instance › Headers

Create a usage validity period instance › Request Body

Create a usage validity period instance › Responses

Get a usage validity period instance

Get a usage validity period instance › path Parameters

Get a usage validity period instance › Headers

Get a usage validity period instance › Responses

Update a usage validity period instance

Update a usage validity period instance › path Parameters

Update a usage validity period instance › Headers

Update a usage validity period instance › Request Body

Update a usage validity period instance › Responses

Build with Entur

Contribute

Terms & Policies

Usage Validity Period

List usage validity period instances

List usage validity period instances › query Parameters

List usage validity period instances › Headers

List usage validity period instances › Responses

Create a usage validity period instance

Create a usage validity period instance › Headers

Create a usage validity period instance › Request Body

Create a usage validity period instance › Responses

Get a usage validity period instance

Get a usage validity period instance › path Parameters

Get a usage validity period instance › Headers

Get a usage validity period instance › Responses

Update a usage validity period instance

Update a usage validity period instance › path Parameters

Update a usage validity period instance › Headers

Update a usage validity period instance › Request Body

Update a usage validity period instance › Responses