type-of-responsibility-role

Server

Download schema

Retrieve all typeOfResponsibilityRoles

GET

https://api.entur.io/products

/type-of-responsibility-role

Retrieve all typeOfResponsibilityRoles › query Parameters

orgId

string · style: form · explode: true

fareFrameId

string · style: form · explode: true

minimizeDataLoad

boolean · style: form · explode: true

Retrieve all typeOfResponsibilityRoles › 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.

Retrieve all typeOfResponsibilityRoles › Responses

Returns the info

FareProduct[]

A FARE PRODUCT response consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT

FareProduct

id

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

Id.

Example: RUT:PreassignedFareProduct:RuterSingleTicket

status

string · enum · required

Status

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: DRAFT

changed

string · required

SalesPackage changed datetime.

created

string · required

SalesPackage create datetime.

nameOfClass

string · required

Name of class.

Example: PreassignedFareProduct

VersionOfObjectRef · required

Fare frame ref.

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

ValidityCondition[] · required

ValidityCondition.

AccessRightInProduct[] · required

AccessRightsInProduct.

GenericParameterAssignment[] · required

AccessRightParameterAssignments.

TextInLanguage[]

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

version

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

Version

Example: NSB:Version:V1

TextInLanguage[]

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

operatorRef

string

OperatorRef.

Example: RUT:Authority:RUT

privateCode

string

PrivateCode.

organisation

string

Organisation who own the product.

VersionOfObjectRef[]

FareTableRef.

organisationId

string

Organisation related to the fareProduct

VersionOfObjectRef

Fare frame ref.

ConditionSummary

A summary of a condition.

fareStructureType

string · enum

FareStructureType.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

Example: ZONE_TO_ZONE_FARE

TypeOfFareProduct

A classification of FARE PRODUCTs.

chargingMomentType

string · enum

ChargingMomentType.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

AT_END_OF_CHARGE_PERIOD

Example: BEFORE_TRAVEL

derivedFromVersionRef

string

Derived from version.

compatibleWithVersionRef

string

CompatibleWithVersionRef

activeComparisonOperatorVariant

string

Indicates whether A or E gpa implementation is active for this SP.

Example: A

GET/type-of-responsibility-role

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

Example Responses

[
  {
    "id": "RUT:PreassignedFareProduct:RuterSingleTicket",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "status": "DRAFT",
    "changed": "changed",
    "created": "created",
    "version": "NSB:Version:V1",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "PreassignedFareProduct",
    "operatorRef": "RUT:Authority:RUT",
    "privateCode": "privateCode",
    "fareFrameRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "modification": "NEW",
    "organisation": "organisation",
    "fareTableRefs": [
      {
        "ref": "ref",
        "version": "version",
        "nameOfClass": "nameOfClass"
      }
    ],
    "chargingMoment": {
      "id": "NSB:ChargingMoment:Prepaid",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "status": "DRAFT",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "ChargingMoment",
      "fareFrameRef": {
        "ref": "ref",
        "version": "version",
        "nameOfClass": "nameOfClass"
      },
      "modification": "NEW",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "compatibleWithVersionRef": "compatibleWithVersionRef"
    },
    "organisationId": "organisationId",
    "limitingRuleRef": {
      "ref": "ref",
      "version": "version",
      "nameOfClass": "nameOfClass"
    },
    "conditionSummary": {
      "id": "NSB:ConditionSummary:1005TEN",
      "isRefundable": true,
      "isExchangeable": true
    },
    "fareStructureType": "ZONE_TO_ZONE_FARE",
    "typeOfFareProduct": {
      "id": "NSB:TypeOfFareProduct:Ordinary",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "status": "DRAFT",
      "changed": "changed",
      "created": "created",
      "version": "NSB:Version:V1",
      "description": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "TypeOfFareProduct",
      "fareFrameRef": {
        "ref": "ref",
        "version": "version",
        "nameOfClass": "nameOfClass"
      },
      "modification": "NEW",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "compatibleWithVersionRef": "compatibleWithVersionRef"
    },
    "chargingMomentType": "BEFORE_TRAVEL",
    "validityConditions": [
      {
        "id": "NSB:ValidBetween:2018",
        "status": "DRAFT",
        "toDate": "toDate",
        "changed": "changed",
        "created": "created",
        "version": "NSB:Version:V1",
        "fromDate": "fromDate",
        "nameOfClass": "ValidBetween",
        "modification": "NEW"
      }
    ],
    "accessRightsInProduct": [
      {
        "id": "NSB:AccessRightInProduct:Ordinary",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "status": "DRAFT",
        "changed": "changed",
        "created": "created",
        "version": "NSB:Version:V1",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Refunding",
        "accessNumber": 0,
        "fareFrameRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "modification": "NEW",
        "maximumAccess": 0,
        "minimumAccess": 0,
        "orderOfElement": 0,
        "isLastInSequence": true,
        "isFirstInSequence": true,
        "limitedAccessNumber": 0,
        "validableElementRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "accessNumberIsLimited": true,
        "derivedFromVersionRef": "derivedFromVersionRef",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "preassignedFareProductRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        }
      }
    ],
    "derivedFromVersionRef": "derivedFromVersionRef",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "accessRightParameterAssignments": [
      {
        "id": "NSB:GenericParameterAssignment:AllowedOperators",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "status": "DRAFT",
        "changed": "changed",
        "created": "created",
        "version": "NSB:Version:V2",
        "includes": [
          null
        ],
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "limitations": [
          {
            "ref": "ref",
            "version": "version",
            "nameOfClass": "nameOfClass"
          }
        ],
        "nameOfClass": "GenericParameterAssignment",
        "fareFrameRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "modification": "NEW",
        "requiredType": "SERVICE_JOURNEY_REF",
        "fareProductRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "salesPackageRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "requiredElements": [
          "string"
        ],
        "chargingBasisType": "FREE",
        "requiredInContext": "OFFERING",
        "validityParameters": [
          {
            "id": "NSB:ScopingValidityParameter:OperatorNSB",
            "status": "DRAFT",
            "changed": "changed",
            "created": "created",
            "lineRef": "lineRef",
            "version": "NSB:Version:V1",
            "lineType": "EXPRESS",
            "placeUse": "START_AT",
            "fareClasses": [
              "string"
            ],
            "fareZoneRef": "KOL:FareZone:250",
            "nameOfClass": "ScopingValidityParameter",
            "operatorRef": "operatorRef",
            "vehicleMode": "AIR",
            "authorityRef": "NSB:Authority:NSB",
            "fareFrameRef": {
              "ref": "ref",
              "version": "version",
              "nameOfClass": "nameOfClass"
            },
            "modification": "NEW",
            "tariffZoneRef": "RUT:TariffZone:2S",
            "facilitySetRef": "facilitySetRef",
            "fareSectionRef": "fareSectionRef",
            "groupOfLinesRef": "ENT:GroupOfLines:AllLines",
            "transportSubmode": "expressBus",
            "topographicPlaceRef": "topographicPlaceRef",
            "derivedFromVersionRef": "derivedFromVersionRef",
            "groupOfTariffZonesRef": "ENT:GroupOfTariffZones:AllZones",
            "scheduledStopPointRef": "scheduledStopPointRef",
            "distributionChannelRef": "ENT:DistributionChannel:App",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "genericParameterAssignmentRef": {
              "ref": "ref",
              "version": "version",
              "nameOfClass": "nameOfClass"
            }
          }
        ],
        "canIgnoreInOffering": true,
        "validableElementRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "includesGroupingType": "AND",
        "derivedFromVersionRef": "NSB:Version:V1",
        "limitationGroupingType": "AND",
        "fareStructureElementRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "compatibleWithVersionRef": "NSB:Version:V1",
        "comparisonOperatorVariant": "A",
        "temporalValidityParameters": [
          {
            "id": "NSB:TemporalValidityParameter:OperatorNSB",
            "status": "DRAFT",
            "changed": "changed",
            "created": "created",
            "dayType": {
              "ref": "ref",
              "version": "version",
              "nameOfClass": "nameOfClass"
            },
            "version": "NSB:Version:V1",
            "nameOfClass": "TemporalValidityParameter",
            "modification": "NEW",
            "groupOfTimeBands": {
              "id": "id",
              "status": "DRAFT",
              "changed": "changed",
              "created": "created",
              "members": [
                {
                  "id": "NSB:Timeband:2HoursValidPlus1",
                  "name": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "status": "DRAFT",
                  "changed": "changed",
                  "created": "created",
                  "endTime": "11:11:11",
                  "version": "NSB:Version:V1",
                  "timeZone": "Europe/Oslo",
                  "dayOffset": 1,
                  "startTime": "11:11:11",
                  "description": [
                    {
                      "lang": "nob",
                      "value": "value"
                    }
                  ],
                  "nameOfClass": "TimeBand",
                  "fareFrameRef": {
                    "ref": "ref",
                    "version": "version",
                    "nameOfClass": "nameOfClass"
                  },
                  "modification": "NEW",
                  "validityConditions": [
                    {
                      "id": "NSB:ValidBetween:2018",
                      "status": "DRAFT",
                      "toDate": "toDate",
                      "changed": "changed",
                      "created": "created",
                      "version": "NSB:Version:V1",
                      "fromDate": "fromDate",
                      "nameOfClass": "ValidBetween",
                      "modification": "NEW"
                    }
                  ],
                  "derivedFromVersionRef": "derivedFromVersionRef",
                  "compatibleWithVersionRef": "compatibleWithVersionRef"
                }
              ],
              "version": "NSB:Version:V1",
              "nameOfClass": "FareStructureElement",
              "modification": "NEW",
              "validityConditions": [
                {
                  "id": "NSB:ValidBetween:2018",
                  "status": "DRAFT",
                  "toDate": "toDate",
                  "changed": "changed",
                  "created": "created",
                  "version": "NSB:Version:V1",
                  "fromDate": "fromDate",
                  "nameOfClass": "ValidBetween",
                  "modification": "NEW"
                }
              ],
              "derivedFromVersionRef": "derivedFromVersionRef",
              "compatibleWithVersionRef": "compatibleWithVersionRef"
            },
            "validityCondition": {
              "id": "NSB:ValidBetween:2018",
              "status": "DRAFT",
              "toDate": "toDate",
              "changed": "changed",
              "created": "created",
              "version": "NSB:Version:V1",
              "fromDate": "fromDate",
              "nameOfClass": "ValidBetween",
              "modification": "NEW"
            },
            "validityConditionRef": {
              "ref": "ref",
              "version": "version",
              "nameOfClass": "nameOfClass"
            },
            "derivedFromVersionRef": "derivedFromVersionRef",
            "compatibleWithVersionRef": "compatibleWithVersionRef",
            "genericParameterAssignmentRef": {
              "ref": "ref",
              "version": "version",
              "nameOfClass": "nameOfClass"
            }
          }
        ],
        "typeOfAccessRightAssignment": {
          "id": "ENT:TypeOfAccessRightAssignment:ActivationPolicyAssignment",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "status": "DRAFT",
          "changed": "changed",
          "created": "created",
          "version": "NSB:Version:V1",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "TypeOfAccessRightAssignment",
          "fareFrameRef": {
            "ref": "ref",
            "version": "version",
            "nameOfClass": "nameOfClass"
          },
          "modification": "NEW",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "compatibleWithVersionRef": "compatibleWithVersionRef"
        },
        "parentParameterAssignmentRef": {
          "ref": "ref",
          "version": "version",
          "nameOfClass": "nameOfClass"
        },
        "validityParameterGroupingType": "AND",
        "validityParameterAssignmentType": "EQ",
        "validityParameterSetSelectionType": "ONE_OF_ANY_ONE_SET"
      }
    ],
    "activeComparisonOperatorVariant": "A"
  }
]

json

application/json

general-groups-of-entities penalty-policy-possibilities

Build with Entur

Contribute

Terms & Policies

type-of-responsibility-role

Retrieve all typeOfResponsibilityRoles

Retrieve all typeOfResponsibilityRoles › query Parameters

Retrieve all typeOfResponsibilityRoles › Headers

Retrieve all typeOfResponsibilityRoles › Responses