companion-profiles

Server

Download schema

deprecated

Retrieves all companion profile

GET

https://api.entur.io/products

/companion-profiles

Retrieves all companion profile › 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 companion profile › 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 companion profile › Responses

Returns the info

CompanionProfile[]

A companion profile

CompanionProfile

changed

string · date-time · required

Changed datetime.

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:CompanionProfile:Adult

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CompanionProfile

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

The version of the companion profile.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the companion profile.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

TextInLanguage[]

The name of the companion profile represented in different languages. Language codes are ISO-639.

VersionOfObjectRef

Fare frame ref.

FarePrice[]

Fare prices for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

userProfileId

string

A user profile defining a category of people eligible to be a companion.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the companion profile.

GET/companion-profiles

curl https://api.entur.io/products/companion-profiles

Example Responses

[
  {
    "changed": "2024-08-25T15:00:00Z",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "2024-08-25T15:00:00Z",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "discountBasis": "DISCOUNT",
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "generalGroupOfEntities": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:CompanionProfile:Adult",
    "limitingRuleRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "maximumNumberOfPersons": 0,
    "minimumNumberOfPersons": 0,
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "CompanionProfile",
    "parentRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "status": "DRAFT",
    "ticketing": "SEPARATE_TICKETS",
    "typeOfUsageParameter": "typeOfUsageParameter",
    "userProfileId": "userProfileId",
    "userProfileRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "version": "NSB:Version:V1"
  }
]

json

application/json

deprecated

Retrives a companion profile by id and version

GET

https://api.entur.io/products

/companion-profiles/{id}/{version}

Retrives a companion profile by id and version › path Parameters

id

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

The unique id to identify a companion profile

version

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

The id for the version of the companion profile

Retrives a companion profile by id and version › query Parameters

languageCode

string · style: form · explode: true

The language code from ISO-639-3

Retrives a companion profile by id and version › Headers

ET-Client-Name

string · style: simple

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.

Retrives a companion profile by id and version › Responses

Returns the info

A companion profile

CompanionProfile

changed

string · date-time · required

Changed datetime.

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:CompanionProfile:Adult

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CompanionProfile

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

The version of the companion profile.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the companion profile.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

TextInLanguage[]

The name of the companion profile represented in different languages. Language codes are ISO-639.

VersionOfObjectRef

Fare frame ref.

FarePrice[]

Fare prices for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

userProfileId

string

A user profile defining a category of people eligible to be a companion.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the companion profile.

GET/companion-profiles/{id}/{version}

curl https://api.entur.io/products/companion-profiles/: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"
    }
  ],
  "discountBasis": "DISCOUNT",
  "fareFrameRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "fareTableRefs": [
    {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    }
  ],
  "generalGroupOfEntities": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "id": "NSB:CompanionProfile:Adult",
  "limitingRuleRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "maximumNumberOfPersons": 0,
  "minimumNumberOfPersons": 0,
  "modification": "NEW",
  "name": [
    {
      "lang": "nob",
      "value": "value"
    }
  ],
  "nameOfClass": "CompanionProfile",
  "parentRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "prices": [
    {
      "amount": "164.0",
      "canBeCumulative": true,
      "changed": "changed",
      "compatibleWithVersionRef": "compatibleWithVersionRef",
      "created": "created",
      "currency": "NOK",
      "derivedFromVersionRef": "derivedFromVersionRef",
      "discountPercentageUsed": 5,
      "fareFrameRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "id": "NSB:FarePrice:1005TEN",
      "isAllowed": true,
      "limitingRule": {
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "discountAsPercentage": 0,
        "discountAsValue": 0,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "id",
        "maximumPrice": "164.0",
        "maximumPriceAsPercentage": 0,
        "minimumLimitPrice": "164.0",
        "minimumPrice": "164.0",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "LimitingRule",
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "modification": "NEW",
      "name": [
        {
          "lang": "nob",
          "value": "value"
        }
      ],
      "nameOfClass": "FarePrice",
      "ranking": 1,
      "rounding": {
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "description": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:Rounding:Ordinary",
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "Rounding",
        "roundingMethod": "NONE",
        "roundingModulus": 0,
        "status": "DRAFT",
        "version": "NSB:Version:V1"
      },
      "roundingRef": {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      },
      "status": "DRAFT",
      "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
      "version": "NSB:Version:V1"
    }
  ],
  "status": "DRAFT",
  "ticketing": "SEPARATE_TICKETS",
  "typeOfUsageParameter": "typeOfUsageParameter",
  "userProfileId": "userProfileId",
  "userProfileRef": {
    "nameOfClass": "nameOfClass",
    "ref": "ref",
    "version": "version"
  },
  "validityConditions": [
    {
      "changed": "changed",
      "created": "created",
      "fromDate": "fromDate",
      "id": "NSB:ValidBetween:2018",
      "modification": "NEW",
      "nameOfClass": "ValidBetween",
      "status": "DRAFT",
      "toDate": "toDate",
      "version": "NSB:Version:V1"
    }
  ],
  "version": "NSB:Version:V1"
}

json

application/json

deprecated

Retrieves a companion profile by id

GET

https://api.entur.io/products

/v1/companion-profiles/{id}

Retrieves a companion profile by id › path Parameters

id

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

The unique id to identify a companion profile

Retrieves a companion profile 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 companion profile

fromDate

string · style: form · explode: true

The from date of the companion profiles version

toDate

string · style: form · explode: true

The to date of the companion profiles version

Retrieves a companion profile 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 a companion profile by id › Responses

Returns the info

CompanionProfile[]

A companion profile

CompanionProfile

changed

string · date-time · required

Changed datetime.

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:CompanionProfile:Adult

modification

string · enum · required

Modification status.

Enum values:

NEW

REVISE

DELETE

Example: NEW

nameOfClass

string · required

Name of class.

Example: CompanionProfile

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

The version of the companion profile.

Example: NSB:Version:V1

compatibleWithVersionRef

string

Compatible with version.

derivedFromVersionRef

string

Derived from version.

TextInLanguage[]

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

discountBasis

string · enum

Basis for discount.

Enum values:

NONE

FREE

DISCOUNT

FULLRATE

Example: DISCOUNT

VersionOfObjectRef[]

References to fare tables that provide prices or discounts for the companion profile.

VersionOfObjectRef

Fare frame ref.

VersionOfObjectRef

Fare frame ref.

maximumNumberOfPersons

integer · int32

Maximum number of allowed companions.

minimumNumberOfPersons

integer · int32

Minimum number of allowed companions.

TextInLanguage[]

The name of the companion profile represented in different languages. Language codes are ISO-639.

VersionOfObjectRef

Fare frame ref.

FarePrice[]

Fare prices for the companion profile.

typeOfUsageParameter

string

typeOfUsageParameter.

userProfileId

string

A user profile defining a category of people eligible to be a companion.

VersionOfObjectRef

Fare frame ref.

ValidityCondition[]

Validity conditions for the companion profile.

GET/v1/companion-profiles/{id}

curl https://api.entur.io/products/v1/companion-profiles/:id

Example Responses

[
  {
    "changed": "2024-08-25T15:00:00Z",
    "compatibleWithVersionRef": "compatibleWithVersionRef",
    "created": "2024-08-25T15:00:00Z",
    "derivedFromVersionRef": "derivedFromVersionRef",
    "description": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "discountBasis": "DISCOUNT",
    "fareFrameRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "fareTableRefs": [
      {
        "nameOfClass": "nameOfClass",
        "ref": "ref",
        "version": "version"
      }
    ],
    "generalGroupOfEntities": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "id": "NSB:CompanionProfile:Adult",
    "limitingRuleRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "maximumNumberOfPersons": 0,
    "minimumNumberOfPersons": 0,
    "modification": "NEW",
    "name": [
      {
        "lang": "nob",
        "value": "value"
      }
    ],
    "nameOfClass": "CompanionProfile",
    "parentRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "prices": [
      {
        "amount": "164.0",
        "canBeCumulative": true,
        "changed": "changed",
        "compatibleWithVersionRef": "compatibleWithVersionRef",
        "created": "created",
        "currency": "NOK",
        "derivedFromVersionRef": "derivedFromVersionRef",
        "discountPercentageUsed": 5,
        "fareFrameRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "id": "NSB:FarePrice:1005TEN",
        "isAllowed": true,
        "limitingRule": {
          "canBeCumulative": true,
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "discountAsPercentage": 0,
          "discountAsValue": 0,
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "id",
          "maximumPrice": "164.0",
          "maximumPriceAsPercentage": 0,
          "minimumLimitPrice": "164.0",
          "minimumPrice": "164.0",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "LimitingRule",
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "modification": "NEW",
        "name": [
          {
            "lang": "nob",
            "value": "value"
          }
        ],
        "nameOfClass": "FarePrice",
        "ranking": 1,
        "rounding": {
          "changed": "changed",
          "compatibleWithVersionRef": "compatibleWithVersionRef",
          "created": "created",
          "derivedFromVersionRef": "derivedFromVersionRef",
          "description": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "fareFrameRef": {
            "nameOfClass": "nameOfClass",
            "ref": "ref",
            "version": "version"
          },
          "id": "NSB:Rounding:Ordinary",
          "modification": "NEW",
          "name": [
            {
              "lang": "nob",
              "value": "value"
            }
          ],
          "nameOfClass": "Rounding",
          "roundingMethod": "NONE",
          "roundingModulus": 0,
          "status": "DRAFT",
          "version": "NSB:Version:V1"
        },
        "roundingRef": {
          "nameOfClass": "nameOfClass",
          "ref": "ref",
          "version": "version"
        },
        "status": "DRAFT",
        "vatRegisterGroup": "TRANSPORT_AND_TICKETS_VAT",
        "version": "NSB:Version:V1"
      }
    ],
    "status": "DRAFT",
    "ticketing": "SEPARATE_TICKETS",
    "typeOfUsageParameter": "typeOfUsageParameter",
    "userProfileId": "userProfileId",
    "userProfileRef": {
      "nameOfClass": "nameOfClass",
      "ref": "ref",
      "version": "version"
    },
    "validityConditions": [
      {
        "changed": "changed",
        "created": "created",
        "fromDate": "fromDate",
        "id": "NSB:ValidBetween:2018",
        "modification": "NEW",
        "nameOfClass": "ValidBetween",
        "status": "DRAFT",
        "toDate": "toDate",
        "version": "NSB:Version:V1"
      }
    ],
    "version": "NSB:Version:V1"
  }
]

json

application/json

charging-policies day-types

Did you find what you were looking for?

companion-profiles

Retrieves all companion profile

Retrieves all companion profile › query Parameters

Retrieves all companion profile › Headers

Retrieves all companion profile › Responses

Retrives a companion profile by id and version

Retrives a companion profile by id and version › path Parameters

Retrives a companion profile by id and version › query Parameters

Retrives a companion profile by id and version › Headers

Retrives a companion profile by id and version › Responses

Retrieves a companion profile by id

Retrieves a companion profile by id › path Parameters

Retrieves a companion profile by id › query Parameters

Retrieves a companion profile by id › Headers

Retrieves a companion profile by id › Responses

Build with Entur

Contribute

Terms & Policies