Schemas latest | Entur for Developers

ErrorResponse

Response object for errors occurring in the customers API

timestamp

string · date-time · required

When the error occurred.

Example: 2007-12-03T10:15:30+01:00

status

integer · int32 · required

The http status code.

Example: 400

error

string · required

The http status reason.

Example: Bad request

path

string · required

The request URI.

Example: /loyaltyPrograms

message

string · required

The main error message.

Example: Validation failed for ...

correlationId

string · required

The unique correlation id for the request.

Example: b5d4960d-7ab2-43d6-a8f3-113da042a288

errorCode

string

Application specific error code

Example: 1033

ErrorSpecification[]

Optional list of error specifications.

ErrorSpecification

Optional list of error specifications.

field

string · required

The field of the associated object in the request related to the error.

defaultMessage

string · required

The message explaining why the error occurred.

rejectedValues

object

A list of rejected values.

GeneratePasswordRequest

Generate a new password for a profile identified by email and organisation id

email

string · minLength: 1 · pattern: ^[a-zA-Z0-9æøåÆØÅ.!#… · required

The email address identifying the profile

Example: customer@example.com

organisationId

integer · int64

The organisation the profile belongs to. Default is tenant organisation ID. Only Internal tenants are allowed to override the organisation id

Example: 1

PurchasedLeg

Legs connected to the customer on the journey

id

string · required

startTime

string · date-time · required

RefType · required

endTime

string · date-time · required

RefType · required

mode

string · required

RefType

purchasedFareProducts

string[]

Reference to Fare Products on this leg

RefType

id

string · required

version

string

TravellerInfo

Each order on the journey enriched with customer information

customerNumber

integer · int64 · required

Customer number

organisationId

integer · int64 · required

The organisation the customer is registered with

orderId

string · required

ID of Order

PurchasedLeg[] · required

Legs connected to the customer on the journey

customerRef

string · minLength: 1 · maxLength: 40

Optional customer reference

firstName

string

First name of the traveller

surname

string

Surname of the traveller

languagePreference

string

Language preference of the traveller in ISO 639-3 code format

email

string · minLength: 1 · maxLength: 80

Contact email

telephoneNumber

string · minLength: 1 · maxLength: 20

Contact telephone number. Includes country code if available

fromStopPlaceRef

string

Reference to the journey’s starting stop

toStopPlaceRef

string

Reference to the journey’s final stop

ChangePasswordRequest

The fields used when verifying credentials

newPassword

string · minLength: 1 · maxLength: 100 · required

The new user password.

oldPassword

string · minLength: 1 · maxLength: 100 · required

The old user password.

ErrorMessage[]

ConvertTemporaryCustomerRequest

The properties used when converting a temporary customer profile

changedBy

string · maxLength: 100 · required

ChangedBy of the temporary customer to be converted to a permanent customer

changedByChannel

string · maxLength: 100 · required

ChangedByChannel of the temporary customer to be converted to a permanent customer

firstName

string · maxLength: 50 · required

First name of the temporary customer to be converted to a permanent customer

surname

string · maxLength: 50 · required

Surname of the temporary customer to be converted to a permanent customer

customerRef

string · minLength: 1 · maxLength: 40

Optional customer reference. Defaults to customer number if not set

email

string · maxLength: 80

Optional email of the temporary customer to be converted to a permanent customer

organisationId

integer · int64

Organisation id of the temporary customer to be converted to a permanent customer

password

string · minLength: 1 · maxLength: 100

Password of the temporary customer to be converted to a permanent customer

CustomerAccountPatchRequest

Update a customer account connected to a customer

alias

string · maxLength: 50

Customer account alias

isDefault

boolean

True if account is the default account for the customer.

CustomerAccountRequest

Create a customer account connected to a customer

accountId

string · maxLength: 60 · required

Customer account id.

alias

string · maxLength: 50 · required

Customer account alias

isDefault

boolean

True if account is default for customer. Default false.

CustomerAccountResponse

Customer account connected to a customer

createdAt

string · date-time · required

When the customer account was created. ISO 8601 date format

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

createdBy

string · required

Who created the customer account.

customerAccountId

string · required

Customer account id string

Example: ATB:CustomerAccount:abc58673cde-1c82-4bc5-989c-9d5eaa7ea866

customerNumber

integer · int64 · required

Unique customer number

id

integer · int64 · required

Customer account unique id.

alias

string

Alias for the customer account

Example: Tommy

changedAt

string · date-time

When the customer account was last changed. ISO 8601 date format

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

changedBy

string

Who changed the customer account.

isDefault

boolean

True if the account is the default account for the customer

CustomerConnectRequest

Request to connect a profile to another profile

changedByChannel

string · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

customerNumberToConnect

integer · int64

Customer number of the profile to connect

Example: 123456

CustomerConnectResponse

Connected temporary profiles for a profile

changedAt

string · date-time · required

When the list of connected profiles was last changed. ISO 8601 date format

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

relatedCustomerNumbers

integer[] · required

Customer numbers for temporary profiles that is connected to a profile

CustomerConsent

Legacy consents for a customer

changedAt

string · date-time

When the customer consent was last changed.

consentChoice

boolean

Whether the customer has approved or declined this consent.

consentCode

string · maxLength: 20

The consent code.

createdAt

string · date-time

When the customer consent was created.

customerId

integer · int64

Id of the customer.

CustomerPostRequest

A registered customer post request

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Examples include web, app, crm. Used for traceability in accordance with GDPR

firstName

string · maxLength: 50 · required

First and middle name.

organisationId

integer · int64 · required

The organisation the customer is registered with.

surname

string · maxLength: 50 · required

Surname.

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerRef

string · minLength: 1 · maxLength: 40

Optional customer reference. Defaults to customer number if not set

dateOfBirth

string · date

Date of birth. ISO 8601 date format

Example: 2019-04-05

email

string · maxLength: 80

Email used for contact and potentially also for login.

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

landlineNumber

string · maxLength: 20

Landline telephone number.

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

password

string · minLength: 1 · maxLength: 100

The users password

PostalAddressRequest[]

The postal addresses connected to the customer.

profileType

string · enum

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

S

P

T

Default: S

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

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

vippsId

string · uuid

Vipps unique user identifier

Example: c06c4afe-d9e1-4c5d-939a-177d752a0944

CustomerPreferenceRequest

Preferences request for a customer

preferenceId

integer · int64 · required

Id of the preference

preferenceValue

string · maxLength: 100

Value of the preference. This can be things like membership number.

CustomerPreferenceResponse

Preferences response for a customer

changedAt

string · date-time · required

When the customer preference was last changed. ISO 8601 date format

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

createdAt

string · date-time · required

When the customer preference was created. ISO 8601 date format

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

PreferenceResponse · required

Preference

preferenceId

integer · int64 · required

Id of the preference

preferenceValue

string · minLength: 1 · maxLength: 100

Value of the preference. This can be things like membership number.

CustomerPutRequest

A registered customer put request. Required fields are firstName, surname, password, organizationId, changedBy and changedByChannel.

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

firstName

string · maxLength: 50 · required

First and middle name.

surname

string · maxLength: 50 · required

Surname.

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

dateOfBirth

string · date

Date of birth. ISO 8601 date format

Example: 2019-04-05

email

string · maxLength: 80

Email used for contact and potentially also for login

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

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

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

landlineNumber

string · maxLength: 80

Landline telephone number.

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

PostalAddressRequest[]

The postal addresses connected to the customer.

status

string · enum

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

A

P

D

Default: A

telephoneNumber

string · maxLength: 80

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

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

vippsId

string · uuid

Vipps unique user identifier

Example: c06c4afe-d9e1-4c5d-939a-177d752a0944

CustomerResponse

A registered customer response

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

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

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

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

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

customerNumber

integer · int64 · required

Customer number.

firstName

string · maxLength: 50 · required

First and middle name.

organisationId

integer · int64 · required

The organisation the customer is registered with.

profileType

string · enum · required

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

S

P

T

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

A

P

D

surname

string · maxLength: 50 · required

Surname.

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

CustomerAccountResponse[]

Customer accounts used for account based ticketing

CustomerConsent[]

The legacy consents connected to the customer.

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

LocalDateResponse

Date as object

LocalDateResponse

Date as object

EcardOwnershipResponse[]

The ecards connected to the customer.

email

string · maxLength: 80

Contact email. May become different from username

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

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

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

landlineNumber

string · maxLength: 20

Landline telephone number.

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

lastSignInAt

string · date-time

When the customer last signed in. ISO 8601 date format

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

lastSignInFrom

string · maxLength: 100

Where the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

parentId

object

Id of the parent customer. Used to connect different customer types.

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

PostalAddressResponse[]

The postal addresses connected to the customer.

CustomerPreferenceResponse[]

The preferences connected to the customer.

relatedCustomerNumbers

integer[]

The customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

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

username

string

Username the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)

vippsId

string · uuid

Vipps unique user identifier

EcardOwnershipRequest

Ecards connected to a customer

ecardNumber

integer · int64 · required

Ecard number.

ecardOperator

integer · int32 · required

Ecard operator.

startOfOwnership

string · date-time · required

When the ecard was first connected to the customer. ISO 8601 date format

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

bookingDate

string · date-time

When the physical ecard was booked. ISO 8601 date format

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

ecardName

string · maxLength: 100

Customer defined ecard alias.

ecardNumber16digits

string · minLength: 16 · maxLength: 16

The 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.

endOfOwnership

string · date-time

When the customer removed the ecard connection. ISO 8601 date format

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

expirationDate

string · date-time

When the physical ecard expires. ISO 8601 date format

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

shippingDate

string · date-time

When the physical ecard was shipped to the customer. ISO 8601 date format

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

EcardOwnershipResponse

Ecards connected to a customer

changedAt

string · date-time · required

When the ecard was last changed. ISO 8601 date format

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

createdAt

string · date-time · required

When the ecard was created. ISO 8601 date format

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

ecardNumber

integer · int64 · required

Ecard number.

ecardNumber16digits

string · minLength: 16 · maxLength: 16 · required

The 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.

ecardOperator

integer · int32 · required

Ecard operator.

id

integer · int64 · required

Ecard id.

startOfOwnership

string · date-time · required

When the ecard was first connected to the customer. ISO 8601 date format

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

bookingDate

string · date-time

When the physical ecard was booked. ISO 8601 date format

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

ecardName

string · maxLength: 100

Customer defined ecard alias.

endOfOwnership

string · date-time

When the customer removed the ecard connection. ISO 8601 date format

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

expirationDate

string · date-time

When the physical ecard expires. ISO 8601 date format

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

shippingDate

string · date-time

When the physical ecard was shipped to the customer. ISO 8601 date format

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

ErrorMessage

An Error message.

errorCode

integer · int32 · required

The error code.

longEnglish

string · required

Long error message (English).

longNorwegian

string · required

Long error message (Norwegian).

shortEnglish

string · required

Short error message (English).

shortNorwegian

string · required

Short error message (Norwegian).

GeneratePasswordResponse

Return object when generating a new password

customerNumber

integer · int64 · required

Customer number.

firstName

string · maxLength: 50 · required

Customer first and middle name.

generatedPassword

string · maxLength: 100 · required

The new generated password.

organisationId

integer · int64 · required

Organisation id.

surname

string · maxLength: 50 · required

Customer surname.

customerRef

string · maxLength: 40

Customer reference

telephoneNumber

string · maxLength: 20

Telephone number for customer. This should be a cell phone number.

ListCustomerAccountResponse

CustomerAccountResponse[]

Customer account connected to a customer

CustomerAccountResponse

createdAt

string · date-time · required

When the customer account was created. ISO 8601 date format

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

createdBy

string · required

Who created the customer account.

customerAccountId

string · required

Customer account id string

Example: ATB:CustomerAccount:abc58673cde-1c82-4bc5-989c-9d5eaa7ea866

customerNumber

integer · int64 · required

Unique customer number

id

integer · int64 · required

Customer account unique id.

alias

string

Alias for the customer account

Example: Tommy

changedAt

string · date-time

When the customer account was last changed. ISO 8601 date format

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

changedBy

string

Who changed the customer account.

isDefault

boolean

True if the account is the default account for the customer

ListCustomerPreferenceRequest

CustomerPreferenceRequest[]

Preferences request for a customer

CustomerPreferenceRequest

preferenceId

integer · int64 · required

Id of the preference

preferenceValue

string · maxLength: 100

Value of the preference. This can be things like membership number.

ListCustomerPreferenceResponse

CustomerPreferenceResponse[]

Preferences response for a customer

CustomerPreferenceResponse

changedAt

string · date-time · required

When the customer preference was last changed. ISO 8601 date format

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

createdAt

string · date-time · required

When the customer preference was created. ISO 8601 date format

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

PreferenceResponse · required

Preference

preferenceId

integer · int64 · required

Id of the preference

preferenceValue

string · minLength: 1 · maxLength: 100

Value of the preference. This can be things like membership number.

ListCustomerResponse

CustomerResponse[]

A registered customer response

CustomerResponse

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

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

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

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

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

customerNumber

integer · int64 · required

Customer number.

firstName

string · maxLength: 50 · required

First and middle name.

organisationId

integer · int64 · required

The organisation the customer is registered with.

profileType

string · enum · required

Type of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.

Enum values:

S

P

T

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

A

P

D

surname

string · maxLength: 50 · required

Surname.

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

CustomerAccountResponse[]

Customer accounts used for account based ticketing

CustomerConsent[]

The legacy consents connected to the customer.

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

LocalDateResponse

Date as object

LocalDateResponse

Date as object

EcardOwnershipResponse[]

The ecards connected to the customer.

email

string · maxLength: 80

Contact email. May become different from username

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

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

expirationDate

string · date-time

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

landlineNumber

string · maxLength: 20

Landline telephone number.

languagePreferenceISO6393

string · enum

Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.

Enum values:

NOB

NNO

ENG

lastSignInAt

string · date-time

When the customer last signed in. ISO 8601 date format

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

lastSignInFrom

string · maxLength: 100

Where the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.

nationality

string · minLength: 3 · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

parentId

object

Id of the parent customer. Used to connect different customer types.

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

PostalAddressResponse[]

The postal addresses connected to the customer.

CustomerPreferenceResponse[]

The preferences connected to the customer.

relatedCustomerNumbers

integer[]

The customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

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

username

string

Username the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)

vippsId

string · uuid

Vipps unique user identifier

LocalDateResponse

Date as object

day

integer · int32 · required

day of month

month

integer · int32 · required

month number

year

integer · int32 · required

year

NewPasswordRequest

The fields used for creating a new password for an user

newPassword

string · minLength: 1 · maxLength: 100 · required

The new password.

ErrorMessage[]

NoteResponse

Deprecated

changedAt

string · date-time · required

When the note was last changed. ISO 8601 date format

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

changedBy

string · maxLength: 100 · required

Who last changed the note.

createdAt

string · date-time · required

When the note was created. ISO 8601 date format

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

createdBy

string · maxLength: 100 · required

Who created the note.

customerId

integer · int64 · required

Id of the customer connected to the note.

id

integer · int64 · required

Note id.

text

string · maxLength: 4000 · required

Note content.

PageCustomerResponse

Page displays a subset of a list of entities

CustomerResponse[] · required

Items on a specific page

totalItems

integer · int64 · required

Total number of items

Example: 72

totalPages

integer · int64 · required

Total number of pages available to browse

Example: 9

PersonnelTicketBearer

The personnel tickets connected to the customer. Deprecated. Does not contain updated information.

bearerCustomerId

integer · int64

changedAt

string · date-time

createdAt

string · date-time

isSelfServedRetrieval

boolean

ticketRightBearer

string

ticketRightOwner

string

PostalAddressRequest

Postal address connected to a customer

countryCode

string · minLength: 3 · maxLength: 3 · required

The address country code. ISO 3166-1 alpha-3 format

Example: NOR

postCode

string · maxLength: 10 · required

The address post code. Only 4 digits for Norwegian addresses.

town

string · required

The address post town. Will be required

typeOfAddress

string · enum · required

The type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.

Enum values:

P

I

S

addressLine1

string · maxLength: 80

Address line 1.

addressLine2

string · maxLength: 80

Address line 2, often used for c/o information.

id

integer · int64

Unique id for postal address. This value is exclusively used when updating a full customer, to identify which of the addresses to update. Otherwise it is ignored.

verifiedAt

string · date-time

When the address was verified. ISO 8601 date format

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

PostalAddressResponse

Postal address connected to a customer

changedAt

string · date-time · required

When the postal address was last changed. ISO 8601 date format

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

countryCode

string · minLength: 3 · maxLength: 3 · required

The address country code. ISO 3166-1 alpha-3 format

Example: NOR

createdAt

string · date-time · required

When the postal address was created. ISO 8601 date format

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

customerId

integer · int64 · required

The customer connected to the address.

id

integer · int64 · required

Postal address id.

postCode

string · maxLength: 10 · required

The address post code.

town

string · maxLength: 50 · required

The address post town.

typeOfAddress

string · enum · required

The type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.

Enum values:

P

I

S

addressLine1

string · maxLength: 80

Address line 1.

addressLine2

string · maxLength: 80

Address line 2, often used for c/o information.

verifiedAt

string · date-time

When the address was verified. ISO 8601 date format

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

PreferenceRequest

Preference

isActive

boolean · required

Whether the preference is active.

preferenceCode

string · maxLength: 20 · required

The preference code.

preferenceDescription

string · maxLength: 255 · required

A description of the preference.

preferenceType

string · maxLength: 20 · required

Type of preference.

PreferenceResponse

Preference

changedAt

string · date-time · required

When the preference was last changed. ISO 8601 date format

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

createdAt

string · date-time · required

When the preference was created. ISO 8601 date format

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

id

integer · int64 · required

Preference id.

isActive

boolean · required

Whether the preference is active.

preferenceCode

string · maxLength: 20 · required

The preference code.

preferenceDescription

string · maxLength: 255 · required

A description of the preference.

preferenceType

string · maxLength: 20 · required

Type of preference.

ProfilesBulkRequest

A request for multiple customers.

customerNumbers

integer[]

Customer numbers to look up. Max 1000 numbers at a time.

customerReferences

string[]

Customer references (aka external references) to look up. Will not be used if non-empty list of customer numbers is provided. Max 1000 references at a time.

includePreferences

boolean

Optional flag to include profile preferences

TemporaryCustomerPostRequest

A registered customer. Required fields are expirationDate, createdBy and createdByChannel.

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

expirationDate

string · date-time · required

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

dateOfBirth

string · date

Date of birth. ISO 8601 date format

Example: 2019-04-05

email

string · maxLength: 80

Contact email

firstName

string · maxLength: 50

First and middle name.

landlineNumber

string · maxLength: 20

Landline telephone number.

organisationId

integer · int64

The organisation the customer is registered with.

surname

string · maxLength: 50

Surname.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

TemporaryCustomerPutRequest

A registered customer

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

expirationDate

string · date-time · required

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

dateOfBirth

string · date

Date of birth. ISO 8601 date format

Example: 2019-04-05

email

string · maxLength: 80

Contact email

firstName

string · maxLength: 50

First and middle name.

landlineNumber

string · maxLength: 20

Landline telephone number.

surname

string · maxLength: 50

Surname.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

TemporaryCustomerResponse

A registered customer

changedAt

string · date-time · required

When the customer was last changed. ISO 8601 date format

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

changedBy

string · maxLength: 100 · required

Who last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

changedByChannel

string · maxLength: 100 · required

Which sales channel or system who last changed the customer. Used for traceability in accordance with GDPR

createdAt

string · date-time · required

When the customer was created. ISO 8601 date format

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

createdBy

string · maxLength: 100 · required

Who created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR

createdByChannel

string · maxLength: 100 · required

Which sales channel or system who created the customer. Used for traceability in accordance with GDPR

customerNumber

integer · int64 · required

Customer number.

expirationDate

string · date-time · required

The date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format

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

firstName

string · maxLength: 50 · required

First and middle name.

organisationId

integer · int64 · required

The organisation the customer is registered with.

status

string · enum · required

Customer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.

Enum values:

A

P

D

surname

string · maxLength: 50 · required

Surname.

uuid

string · minLength: 32 · maxLength: 32 · required

A universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant

Example: 7018222E18CB5C46E05400144FF9F89C

countryCode

string · maxLength: 4

Telephone number country code, starting with +.

Example: +47

customerAccountId

string · maxLength: 60

Customer account id used for account based ticketing

Example: XYZ:CustomerAccount:<uuid>

CustomerConsent[]

The legacy consents connected to the customer.

customerRef

string · maxLength: 40

Optional customer reference. Defaults to customer number if not set.

dateOfBirth

string · date

Date of birth. ISO 8601 date format

Example: 2019-04-05

dateOfDeath

string · date

Date of death. ISO 8601 date format

Example: 2019-04-05

email

string · maxLength: 80

Contact email.

emailOld

string · maxLength: 80

When customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.

emailVerifiedAt

string · date-time

When the email was verified. ISO 8601 date format

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

landlineNumber

string · maxLength: 20

Landline telephone number.

nationality

string · maxLength: 3

The customers nationality. ISO 3166-1 alpha-3 format

Example: NOR

NoteResponse[]

The notes connected to the customer.

PostalAddressResponse[]

The postal addresses connected to the customer.

CustomerPreferenceResponse[]

The preferences connected to the customer.

telephoneNumber

string · maxLength: 20

Deprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.

telephoneNumberNoCountryCode

string · maxLength: 12

Telephone number without country code or punctuation.

telephoneNumberVerifiedAt

string · date-time

When the telephone number was verified. ISO 8601 date format

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

VerifyCredentialsRequest

The fields used when verifying credentials

email

string · maxLength: 80 · required

Email used for login. See property 'username' on CustomerResponse

password

string · minLength: 1 · maxLength: 100 · required

Password used for login.

lastSignInFrom

string · maxLength: 100

The place if login. Typically web or app. Typically used to display to the user where the last login was performed.

ErrorMessage[]