charging-moments

Server

Download schema

Create a charging moment controller

POST

https://api.entur.io/products

/charging-moments

Create a charging moment controller › 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

Create a charging moment controller › Request Body

ChargingMomentInsert

id

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

Id.

Example: NSB:ChargingMoment:Prepaid

version

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

Charging moment version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

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

TextInLanguage[]

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

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Create a charging moment controller › Responses

Entity created successfully

No data returned

POST/charging-moments

curl https://api.entur.io/products/charging-moments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:ChargingMoment:Prepaid",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}'

Example Request Body

{
  "id": "NSB:ChargingMoment:Prepaid",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

Example Responses

No example specified for this content type

Retrieves charging moment for id and version

GET

https://api.entur.io/products

/charging-moments/{id}/{version}

Retrieves charging moment for id and version › path Parameters

id

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

The id to identify a ChargingMooment

version

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

The id for the version of the ChargingMoment

Retrieves charging moment for 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.

Retrieves charging moment for id and version › Responses

Returns the info

A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.

ChargingMoment

id

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

Id.

Example: NSB:ChargingMoment:Prepaid

status

string · enum · readOnly · required

Charging moment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

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

Charging moment version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingMoment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

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

TextInLanguage[]

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

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

security-policy journey-patterns

Products

charging-moments

Server

Download schema

Create a charging moment controller

POST

https://api.entur.io/products

/charging-moments

Create a charging moment controller › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create a charging moment controller › Request Body

ChargingMomentInsert

id

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

Id.

Example: NSB:ChargingMoment:Prepaid

version

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

Charging moment version.

Example: NSB:Version:V1

VersionOfObjectRef · required

Fare frame ref.

TextInLanguage[]

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

TextInLanguage[]

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

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

Compatible with version.

Create a charging moment controller › Responses

Entity created successfully

No data returned

POST/charging-moments

curl https://api.entur.io/products/charging-moments \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "NSB:ChargingMoment:Prepaid",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}'

Example Request Body

{
  "id": "NSB:ChargingMoment:Prepaid",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "version": "NSB:Version:V1",
  "description": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "fareFrameRef": {
    "ref": "ref",
    "version": "version",
    "nameOfClass": "nameOfClass"
  },
  "derivedFromVersionRef": "derivedFromVersionRef",
  "compatibleWithVersionRef": "compatibleWithVersionRef"
}

json

Example Responses

No example specified for this content type

Retrieves charging moment for id and version

GET

https://api.entur.io/products

/charging-moments/{id}/{version}

Retrieves charging moment for id and version › path Parameters

id

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

The id to identify a ChargingMooment

version

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

The id for the version of the ChargingMoment

Retrieves charging moment for 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.

Retrieves charging moment for id and version › Responses

Returns the info

ChargingMoment

id

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

Id.

Example: NSB:ChargingMoment:Prepaid

status

string · enum · readOnly · required

Charging moment status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · readOnly · required

Changed datetime.

created

string · readOnly · required

Created datetime.

version

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

Charging moment version.

Example: NSB:Version:V1

nameOfClass

string · readOnly · required

Name of class.

Example: ChargingMoment

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · readOnly · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

TextInLanguage[]

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

TextInLanguage[]

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

derivedFromVersionRef

string · readOnly

Derived from version.

compatibleWithVersionRef

string · readOnly

Compatible with version.

security-policy journey-patterns

charging-moments

Create a charging moment controller

Create a charging moment controller › Headers

Create a charging moment controller › Request Body

Create a charging moment controller › Responses

Retrieves charging moment for id and version

Retrieves charging moment for id and version › path Parameters

Retrieves charging moment for id and version › Headers

Retrieves charging moment for id and version › Responses

Build with Entur

Contribute

Terms & Policies

charging-moments

Create a charging moment controller

Create a charging moment controller › Headers

Create a charging moment controller › Request Body

Create a charging moment controller › Responses

Retrieves charging moment for id and version

Retrieves charging moment for id and version › path Parameters

Retrieves charging moment for id and version › Headers

Retrieves charging moment for id and version › Responses