uvp-for-number-of-zones

Server

Download schema

uvp-for-number-of-zones

GET

https://api.entur.io/products

/uvp-for-number-of-zones

uvp-for-number-of-zones › 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

uvp-for-number-of-zones › 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.

uvp-for-number-of-zones › Responses

Returns the info

UVPForNumberOfZones[]

UVPForNumberOfZones

id

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

Id.

Example: RUT:UVPForNumberOfZones:example

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

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

nameOfClass

string · required

Name of class.

Example: UVPForNumberOfZones

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

zoneRange

string

Zone range.

Example: 4:9

Create a uvpForNumberOfZones

POST

https://api.entur.io/products

/uvp-for-number-of-zones

Create a uvpForNumberOfZones › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create a uvpForNumberOfZones › Request Body

UVPForNumberOfZonesInsert

id

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

Id.

Example: NSB:UVPForNumberOFZones:123

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

version

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

Version.

Example: NSB:Version:V1

zoneRange

string

Zone range.

Example: 4:9

Create a uvpForNumberOfZones › Responses

Entity created successfully

No data returned

POST/uvp-for-number-of-zones

curl https://api.entur.io/products/uvp-for-number-of-zones \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:UVPForNumberOFZones:123",
  "version": "NSB:Version:V1",
  "zoneRange": "4:9",
  "authorityId": "RUT:Authority:RUT",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "numberOfZones": 3,
  "usageValidityPeriodId": "NSB:UsageValidityPeriod:Child"
}'

Example Request Body

{
  "id": "NSB:UVPForNumberOFZones:123",
  "version": "NSB:Version:V1",
  "zoneRange": "4:9",
  "authorityId": "RUT:Authority:RUT",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "numberOfZones": 3,
  "usageValidityPeriodId": "NSB:UsageValidityPeriod:Child"
}

json

Example Responses

No example specified for this content type

Update a list of uvpForZones

PUT

https://api.entur.io/products

/uvp-for-number-of-zones/batch

Update a list of uvpForZones › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update a list of uvpForZones › Request Body

SeqUVPForNumberOfZonesInsert[]

SeqUVPForNumberOfZonesInsert

empty

boolean

traversableAgain

boolean

Update a list of uvpForZones › Responses

Entity updated successfully

No data returned

Create a list of uvp for number of zones

POST

https://api.entur.io/products

/uvp-for-number-of-zones/batch

Create a list of uvp for number of zones › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create a list of uvp for number of zones › Request Body

SeqUVPForNumberOfZonesInsert[]

SeqUVPForNumberOfZonesInsert

empty

boolean

traversableAgain

boolean

Create a list of uvp for number of zones › Responses

Entity created successfully

No data returned

Retrieves a uvpForNumberOfZones by id

GET

https://api.entur.io/products

/v1/uvp-for-number-of-zones/{id}

Retrieves a uvpForNumberOfZones by id › path Parameters

id

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

The unique id to identify a charging moment

Retrieves a uvpForNumberOfZones 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 charging moment

fromDate

string · style: form · explode: true

The from date of the charging moments version

toDate

string · style: form · explode: true

The to date of the charging moments version

Retrieves a uvpForNumberOfZones 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.

Retrieves a uvpForNumberOfZones by id › Responses

Returns the info

UVPForNumberOfZones[]

UVPForNumberOfZones

id

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

Id.

Example: RUT:UVPForNumberOfZones:example

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

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

nameOfClass

string · required

Name of class.

Example: UVPForNumberOfZones

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

zoneRange

string

Zone range.

Example: 4:9

Retrives a UVPForNumberOfZones by id

GET

https://api.entur.io/products

/uvp-for-number-of-zones/{id}/{version}

Retrives a UVPForNumberOfZones by id › path Parameters

id

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

The unique id to identify a UVPForNumberOfZones

version

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

The id for the version of the UVPForNumberOfZones

Retrives a UVPForNumberOfZones by id › query Parameters

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrives a UVPForNumberOfZones 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 UVPForNumberOfZones by id › Responses

Returns the info

UVPForNumberOfZones

id

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

Id.

Example: RUT:UVPForNumberOfZones:example

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

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

nameOfClass

string · required

Name of class.

Example: UVPForNumberOfZones

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

zoneRange

string

Zone range.

Example: 4:9

Update a uvpForNumberOfZones

PUT

https://api.entur.io/products

/uvp-for-number-of-zones/{id}/{version}

Update a uvpForNumberOfZones › path Parameters

id

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

The unique id to identify a UVPForNumberOfZones

version

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

The id for the version of the UVPForNumberOfZones

Update a uvpForNumberOfZones › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update a uvpForNumberOfZones › Request Body

UVPForNumberOfZonesInsert

id

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

Id.

Example: NSB:UVPForNumberOFZones:123

authorityId

string · required

Reference to authority.

Example: RUT:Authority:RUT

VersionOfObjectRef · required

Fare frame ref.

numberOfZones

integer · int64 · required

Number of zones.

Example: 3

usageValidityPeriodId

string · required

Reference to usage validity period.

Example: NSB:UsageValidityPeriod:Child

version

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

Version.

Example: NSB:Version:V1

zoneRange

string

Zone range.

Example: 4:9

Update a uvpForNumberOfZones › Responses

Entity updated successfully

No data returned

PUT/uvp-for-number-of-zones/{id}/{version}

curl https://api.entur.io/products/uvp-for-number-of-zones/:id/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:UVPForNumberOFZones:123",
  "version": "NSB:Version:V1",
  "zoneRange": "4:9",
  "authorityId": "RUT:Authority:RUT",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "numberOfZones": 3,
  "usageValidityPeriodId": "NSB:UsageValidityPeriod:Child"
}'

Example Request Body

{
  "id": "NSB:UVPForNumberOFZones:123",
  "version": "NSB:Version:V1",
  "zoneRange": "4:9",
  "authorityId": "RUT:Authority:RUT",
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "numberOfZones": 3,
  "usageValidityPeriodId": "NSB:UsageValidityPeriod:Child"
}

json

Example Responses

No example specified for this content type

refunding-possibilities distance-matrix-elements

Build with Entur

Contribute

Terms & Policies

uvp-for-number-of-zones

uvp-for-number-of-zones

uvp-for-number-of-zones › query Parameters

uvp-for-number-of-zones › Headers

uvp-for-number-of-zones › Responses

Create a uvpForNumberOfZones

Create a uvpForNumberOfZones › Headers

Create a uvpForNumberOfZones › Request Body

Create a uvpForNumberOfZones › Responses

Update a list of uvpForZones

Update a list of uvpForZones › Headers

Update a list of uvpForZones › Request Body

Update a list of uvpForZones › Responses

Create a list of uvp for number of zones

Create a list of uvp for number of zones › Headers

Create a list of uvp for number of zones › Request Body

Create a list of uvp for number of zones › Responses

Retrieves a uvpForNumberOfZones by id

Retrieves a uvpForNumberOfZones by id › path Parameters

Retrieves a uvpForNumberOfZones by id › query Parameters

Retrieves a uvpForNumberOfZones by id › Headers

Retrieves a uvpForNumberOfZones by id › Responses

Retrives a UVPForNumberOfZones by id

Retrives a UVPForNumberOfZones by id › path Parameters

Retrives a UVPForNumberOfZones by id › query Parameters

Retrives a UVPForNumberOfZones by id › Headers

Retrives a UVPForNumberOfZones by id › Responses

Update a uvpForNumberOfZones

Update a uvpForNumberOfZones › path Parameters

Update a uvpForNumberOfZones › Headers

Update a uvpForNumberOfZones › Request Body

Update a uvpForNumberOfZones › Responses