Consents admin

Download schema

Api for creating, fetching, modifying and deleting consents by admins

GET

https://api.entur.io/customers/v2/consents

/admin/consents/{id}

Get a consent by its id.

id

integer · int64 · required · style: simple

The id of the consent to retrieve

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

Consent response, includes the consent base

ConsentResponse

changedAt

string · date-time · required

When the consent was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentBaseResponse · required

Consent base

consentCode

string · required

Code of the consent base

createdAt

string · date-time · required

When the consent was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

id

integer · int64 · required

Consent ID.

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

organisationId

integer · int64 · required

The organisation the consent is valid for.

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

validTo

string · date-time

If set, the date the consent is valid to. Set the date to deactivate the consent. Can only be set to a date before the consent base validTo. If not set the consent is active from validFrom and forever after.

GET/admin/consents/{id}

curl https://api.entur.io/customers/v2/consents/admin/consents/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentBase": {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  },
  "consentCode": "consentCode",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "id": 0,
  "isEmailSupported": true,
  "isSmsSupported": true,
  "organisationId": 0,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}

json

application/json

PUT

https://api.entur.io/customers/v2/consents

/admin/consents/{id}

Update a consent by its id. Only consents in DRAFT state can be updated.

id

integer · int64 · required · style: simple

The id of the consent to update

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Adds a consent to a given consent base.

ConsentRequest

consentCode

string · required

Consent code. Use the consent code + consent base version to identify the consent base

Example: ENT_INFO_SMS

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

Example: true

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

Example: false

organisationId

integer · int64 · required

The organisation the consent is valid for.

consentBaseVersion

integer · int32

Consent base version for adding a consent to a specific version. If not provided, the latest version is used.

Example: 1

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

Example: 2019-04-05T14:30:30+02:00

Consent response, includes the consent base

ConsentResponse

changedAt

string · date-time · required

When the consent was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentBaseResponse · required

Consent base

consentCode

string · required

Code of the consent base

createdAt

string · date-time · required

When the consent was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

id

integer · int64 · required

Consent ID.

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

organisationId

integer · int64 · required

The organisation the consent is valid for.

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

validTo

string · date-time

PUT/admin/consents/{id}

curl https://api.entur.io/customers/v2/consents/admin/consents/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "consentBaseVersion": 1,
  "consentCode": "ENT_INFO_SMS",
  "isEmailSupported": true,
  "isSmsSupported": false,
  "organisationId": 0,
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "consentBaseVersion": 1,
  "consentCode": "ENT_INFO_SMS",
  "isEmailSupported": true,
  "isSmsSupported": false,
  "organisationId": 0,
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentBase": {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  },
  "consentCode": "consentCode",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "id": 0,
  "isEmailSupported": true,
  "isSmsSupported": true,
  "organisationId": 0,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}

json

application/json

DELETE

https://api.entur.io/customers/v2/consents

/admin/consents/{id}

Delete a consent by its id.

id

integer · int64 · required · style: simple

The id of the consent to delete

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

No Content

No data returned

PATCH

https://api.entur.io/customers/v2/consents

/admin/consents/{id}

Update the valid to for an active consent. This is the only thing that can be changed after a consent is active. If you want to change other fields you have to create a new consent.

id

integer · int64 · required · style: simple

The id of the consent to update

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Request to set the valid to date for a consent

ConsentPatchRequest

validTo

string · date-time

If set, the date the consent is valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and forever after

Example: 2019-04-05T14:30:30+02:00

Consent response, includes the consent base

ConsentResponse

changedAt

string · date-time · required

When the consent was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentBaseResponse · required

Consent base

consentCode

string · required

Code of the consent base

createdAt

string · date-time · required

When the consent was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

id

integer · int64 · required

Consent ID.

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

organisationId

integer · int64 · required

The organisation the consent is valid for.

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

validTo

string · date-time

PATCH/admin/consents/{id}

curl https://api.entur.io/customers/v2/consents/admin/consents/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentBase": {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  },
  "consentCode": "consentCode",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "id": 0,
  "isEmailSupported": true,
  "isSmsSupported": true,
  "organisationId": 0,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions/{version}

Find a specific version of a consent base

consentCode

string · required · style: simple

The consent code of the consent base for which to to find a version.

version

integer · int32 · required · style: simple

The version to find

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

GET/admin/consent-bases/{consentCode}/versions/{version}

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode/versions/:version \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

PUT

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions/{version}

Update a consent base version by its consent code. Note: you can only edit draft versions of consent bases. If you want to update an active consent base, you need to create a new version.

consentCode

string · required · style: simple

The consent code of the consent base to update.

version

integer · int32 · required · style: simple

The version to update

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Request body for updating a consent base in draft mode or creating a new version of a consent base.

ConsentBaseVersionRequest

ConsentTermsRequest[] · required

Consent description and terms in multiple languages. Supports MarkDown

InternalDescriptionRequest[]

Internal description, describing what the usecases are for the consent

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within consentDescription and consentTerms. Facilitates reusable consents across organisations.

Example: [ORG]

validFrom

string · date-time

The date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set the consent is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base id valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and forever after

Example: 2019-04-05T14:30:30+02:00

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

PUT/admin/consent-bases/{consentCode}/versions/{version}

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode/versions/:version \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

DELETE

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions/{version}

Delete a consent base version

consentCode

string · required · style: simple

The consent code of the consent base to delete version for.

version

integer · int32 · required · style: simple

The version to delete

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

No Content

No data returned

PATCH

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions/{version}

Patch an active consent base version.

consentCode

string · required · style: simple

The consent code of the consent base to patch version for.

version

integer · int32 · required · style: simple

The version to patch

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Request to update updatable fields after the consent base is active

ConsentBaseVersionPatchRequest

InternalDescriptionRequest[]

The internal description. Is only exposed for admin endpoints

ConsentTermsRequest[]

Terms to add. Only new languages can be added to existing terms. Updating terms for an existing language will result in an exception.

validTo

string · date-time

If set, the date the consent base is valid to. Set the date to deactivate the consent base. If not set, the consent base is active from validFrom and onwards

Example: 2019-04-05T14:30:30+02:00

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

PATCH/admin/consent-bases/{consentCode}/versions/{version}

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode/versions/:version \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

Find consents

GET

https://api.entur.io/customers/v2/consents

/admin/consents

Find consents filtered by given query parameters

Find consents › query Parameters

organisationIds

integer[] · style: form · explode: true

Filter consents by organisation ids (comma separated).

consentCodes

string[] · style: form · explode: true

Filter consents by consent codes (comma separated).

versions

string[] · style: form · explode: true

Filter consents by versions (comma separated). You can also use the keywords ALL or CURRENT. Example: versions=1,2 or versions=CURRENT

Default: ["CURRENT"]

includeInactive

boolean · style: form · explode: true

Whether or not to include inactive consents (default: false)

Find consents › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Find consents › Responses

ConsentResponse[]

Consent response, includes the consent base

ConsentResponse

changedAt

string · date-time · required

When the consent was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentBaseResponse · required

Consent base

consentCode

string · required

Code of the consent base

createdAt

string · date-time · required

When the consent was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

id

integer · int64 · required

Consent ID.

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

organisationId

integer · int64 · required

The organisation the consent is valid for.

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

validTo

string · date-time

GET/admin/consents

curl https://api.entur.io/customers/v2/consents/admin/consents \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentBase": {
      "changedAt": "2019-04-05T14:30:30+02:00",
      "consentCode": "ENT_INFO_SMS",
      "consentOwnerOrgId": 0,
      "createdAt": "2019-04-05T14:30:30+02:00",
      "internalDescription": [
        {
          "description": "description",
          "languageCode": "ENG"
        }
      ],
      "orgNameSubstitutionPattern": "[ORG]",
      "terms": [
        {
          "fullDescription": "fullDescription",
          "languageCode": "ENG",
          "shortDescription": "shortDescription"
        }
      ],
      "validFrom": "2019-04-05T14:30:30+02:00",
      "validTo": "2019-04-05T14:30:30+02:00",
      "version": 0
    },
    "consentCode": "consentCode",
    "createdAt": "2019-04-05T14:30:30+02:00",
    "id": 0,
    "isEmailSupported": true,
    "isSmsSupported": true,
    "organisationId": 0,
    "validFrom": "2024-08-25T15:00:00Z",
    "validTo": "2024-08-25T15:00:00Z"
  }
]

json

application/json

POST

https://api.entur.io/customers/v2/consents

/admin/consents

Add a consent to a consent base

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Adds a consent to a given consent base.

ConsentRequest

consentCode

string · required

Consent code. Use the consent code + consent base version to identify the consent base

Example: ENT_INFO_SMS

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

Example: true

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

Example: false

organisationId

integer · int64 · required

The organisation the consent is valid for.

consentBaseVersion

integer · int32

Consent base version for adding a consent to a specific version. If not provided, the latest version is used.

Example: 1

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

Example: 2019-04-05T14:30:30+02:00

Consent response, includes the consent base

ConsentResponse

changedAt

string · date-time · required

When the consent was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentBaseResponse · required

Consent base

consentCode

string · required

Code of the consent base

createdAt

string · date-time · required

When the consent was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

id

integer · int64 · required

Consent ID.

isEmailSupported

boolean · required

Whether the organisation supports email as a contact method

isSmsSupported

boolean · required

Whether the organisation supports SMS as a contact method

organisationId

integer · int64 · required

The organisation the consent is valid for.

validFrom

string · date-time

If set, the date the consent is valid from. Can only be set to a date after consent base validFrom. If not set, the consent base is in draft mode.

validTo

string · date-time

POST/admin/consents

curl https://api.entur.io/customers/v2/consents/admin/consents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "consentBaseVersion": 1,
  "consentCode": "ENT_INFO_SMS",
  "isEmailSupported": true,
  "isSmsSupported": false,
  "organisationId": 0,
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "consentBaseVersion": 1,
  "consentCode": "ENT_INFO_SMS",
  "isEmailSupported": true,
  "isSmsSupported": false,
  "organisationId": 0,
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentBase": {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  },
  "consentCode": "consentCode",
  "createdAt": "2019-04-05T14:30:30+02:00",
  "id": 0,
  "isEmailSupported": true,
  "isSmsSupported": true,
  "organisationId": 0,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://api.entur.io/customers/v2/consents

/admin/consent-bases

List all available consent bases

includeAllVersions

boolean · style: form · explode: true

Whether or not to include all versions of all consents bases. If set to false, will only return the currently active versions. (default: false)

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

ConsentBaseResponse[]

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

GET/admin/consent-bases

curl https://api.entur.io/customers/v2/consents/admin/consent-bases \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  }
]

json

application/json

POST

https://api.entur.io/customers/v2/consents

/admin/consent-bases

Create a consent base

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Create new consent base

ConsentBaseRequest

consentCode

string · maxLength: 20 · required

Consent code, identifying the consent base. Must be unique within the system, prefixing it with the organisation's code space is advisable tp avoid conflict. Has a maximum length of 20 characters.

Example: ENT_INFO_SMS

ConsentTermsRequest[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

consentOwnerOrgId

integer · int64

The organisation that owns the consent. If not set all organisations can use the consent base. |If you're a partner, this will be filled out from your authentication token.

InternalDescriptionRequest[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent bases across organisations.

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

POST/admin/consent-bases

curl https://api.entur.io/customers/v2/consents/admin/consent-bases \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

GET

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions

Returns a list of all versions for the consent base

consentCode

string · required · style: simple

The consent code of the consent base for which to find versions.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

ConsentBaseResponse[]

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

GET/admin/consent-bases/{consentCode}/versions

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode/versions \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "changedAt": "2019-04-05T14:30:30+02:00",
    "consentCode": "ENT_INFO_SMS",
    "consentOwnerOrgId": 0,
    "createdAt": "2019-04-05T14:30:30+02:00",
    "internalDescription": [
      {
        "description": "description",
        "languageCode": "ENG"
      }
    ],
    "orgNameSubstitutionPattern": "[ORG]",
    "terms": [
      {
        "fullDescription": "fullDescription",
        "languageCode": "ENG",
        "shortDescription": "shortDescription"
      }
    ],
    "validFrom": "2019-04-05T14:30:30+02:00",
    "validTo": "2019-04-05T14:30:30+02:00",
    "version": 0
  }
]

json

application/json

POST

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}/versions

Create a new version and update values for a consent base.

consentCode

string · required · style: simple

The consent code of the consent base to update.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Request body for updating a consent base in draft mode or creating a new version of a consent base.

ConsentBaseVersionRequest

ConsentTermsRequest[] · required

Consent description and terms in multiple languages. Supports MarkDown

InternalDescriptionRequest[]

Internal description, describing what the usecases are for the consent

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within consentDescription and consentTerms. Facilitates reusable consents across organisations.

Example: [ORG]

validFrom

string · date-time

The date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set the consent is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base id valid to. Set the date to deactivate the consent. If not set the consent is active from validFrom and forever after

Example: 2019-04-05T14:30:30+02:00

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

POST/admin/consent-bases/{consentCode}/versions

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode/versions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}'

Example Request Body

{
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00"
}

json

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

GET

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}

Returns the currently active version of consent base. Returns 404 if the are no active versions.

consentCode

string · required · style: simple

The consent code of the consent base to find.

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Consent base

ConsentBaseResponse

changedAt

string · date-time · required

When the consent base was last changed. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

consentCode

string · required

Consent code used to identify the consent base

Example: ENT_INFO_SMS

createdAt

string · date-time · required

When the consent base was created. ISO 8601 date format

Example: 2019-04-05T14:30:30+02:00

ConsentTermsResponse[] · required

Consent terms with long and short description in multiple languages. The descriptions can contain MarkDown

version

integer · int32 · required

The consent base version

consentOwnerOrgId

integer · int64

The organisation that owns the consent base. If not set, the consent base can be used by all organisations.

InternalDescriptionResponse[]

Internal description, describing the use cases for the consent base

orgNameSubstitutionPattern

string

The pattern on which to perform substitution within terms. Facilitates reusable consent basess across organisations

Example: [ORG]

validFrom

string · date-time

If set, the date the consent base is valid from. It is not possible to change the consent terms after this date without creating a new version. If not set, the consent base is in draft mode.

Example: 2019-04-05T14:30:30+02:00

validTo

string · date-time

If set, the date the consent base is valid to. If this date is in the past, the consent base is deactivated. If not set, the consent is active from validFrom and onwards.

Example: 2019-04-05T14:30:30+02:00

GET/admin/consent-bases/{consentCode}

curl https://api.entur.io/customers/v2/consents/admin/consent-bases/:consentCode \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "changedAt": "2019-04-05T14:30:30+02:00",
  "consentCode": "ENT_INFO_SMS",
  "consentOwnerOrgId": 0,
  "createdAt": "2019-04-05T14:30:30+02:00",
  "internalDescription": [
    {
      "description": "description",
      "languageCode": "ENG"
    }
  ],
  "orgNameSubstitutionPattern": "[ORG]",
  "terms": [
    {
      "fullDescription": "fullDescription",
      "languageCode": "ENG",
      "shortDescription": "shortDescription"
    }
  ],
  "validFrom": "2019-04-05T14:30:30+02:00",
  "validTo": "2019-04-05T14:30:30+02:00",
  "version": 0
}

json

application/json

DELETE

https://api.entur.io/customers/v2/consents

/admin/consent-bases/{consentCode}

Delete a consent base and all it's versions

consentCode

string · required · style: simple

The consent code of the consent base to delete

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

No Content

No data returned

Consents DWH

Did you find what you were looking for?

Consents admin

Find consents

Find consents › query Parameters

Find consents › Headers

Find consents › Responses

Build with Entur

Contribute

Terms & Policies

Consents admin

Get a consent

Get a consent › path Parameters

Get a consent › Headers

Get a consent › Responses

Update a draft consent

Update a draft consent › path Parameters

Update a draft consent › Headers

Update a draft consent › Request Body

Update a draft consent › Responses

Delete a consent

Delete a consent › path Parameters

Delete a consent › Headers

Delete a consent › Responses

Update an active consent

Update an active consent › path Parameters

Update an active consent › Headers

Update an active consent › Request Body

Update an active consent › Responses

Find version of a consent base

Find version of a consent base › path Parameters

Find version of a consent base › Headers

Find version of a consent base › Responses

Update a consent base version.

Update a consent base version. › path Parameters

Update a consent base version. › Headers

Update a consent base version. › Request Body

Update a consent base version. › Responses

Delete a consent base version

Delete a consent base version › path Parameters

Delete a consent base version › Headers

Delete a consent base version › Responses

Patch a consent base version

Patch a consent base version › path Parameters

Patch a consent base version › Headers

Patch a consent base version › Request Body

Patch a consent base version › Responses

Find consents

Find consents › query Parameters

Find consents › Headers

Find consents › Responses

Add a consent

Add a consent › Headers

Add a consent › Request Body

Add a consent › Responses

Find all consent bases

Find all consent bases › query Parameters

Find all consent bases › Headers

Find all consent bases › Responses

Create a consent base

Create a consent base › Headers

Create a consent base › Request Body

Create a consent base › Responses

Find all consent base versions

Find all consent base versions › path Parameters

Find all consent base versions › Headers

Find all consent base versions › Responses

Create a new version and update values for a consent base.

Create a new version and update values for a consent base. › path Parameters

Create a new version and update values for a consent base. › Headers

Create a new version and update values for a consent base. › Request Body

Create a new version and update values for a consent base. › Responses

Find current version of consent base

Find current version of consent base › path Parameters

Find current version of consent base › Headers

Find current version of consent base › Responses

Delete a consent base

Delete a consent base › path Parameters

Delete a consent base › Headers

Delete a consent base › Responses