Skip to main content
Get All Consent Purpose

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

OK

Primary key

Name
string

Name of consent purpose

Form text used for the actual checkbox

FormText
string

Text for the consent form, the long text to be shown when asking the end-user for this kind of consent

Key
string

The key used to refer to this purpose, like #Process, #Emarketing etc.

Tooltip
string

List item tooltip

Active
integer<int32>

Is the consent purpose active or not

UpdatedDate
string<date-time>

The date the consent purpose was last updated in UTC.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Deleted
boolean

true if the ConsentPurpose is deleted

Rank
integer<int32>

Rank order

PrivacyStatementDesc
string

Name or description for the privacy statement

PrivacyStatementUrl
string

Url referencing the actual privacy statement

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.