Skip to main content

Class ConsentPurpose

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for ConsentPurpose.

Inheritance

objectCarrierConsentPurpose

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get ConsentPurpose 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var consentPurpose = agent.GetConsentPurpose( 123 );

Constructors

ConsentPurpose()

Default constructor - defaults any enum props to 0.

Properties

Active

Is the consent purpose active or not

Property Value

short

ConsentPurposeId

Primary key

Property Value

int

ConsentText

Form text used for the actual checkbox

Property Value

string

Deleted

true if the ConsentPurpose is deleted

Property Value

bool

FormText

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

Property Value

string

Key

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

Property Value

string

Name

Name of consent purpose

Property Value

string

PrivacyStatementDesc

Name or description for the privacy statement

Property Value

string

PrivacyStatementUrl

Url referencing the actual privacy statement

Property Value

string

Rank

Rank order

Property Value

short

Tooltip

List item tooltip

Property Value

string

UpdatedBy

The associate that last updated the consent purpose

Property Value

Associate

UpdatedDate

The date the consent purpose was last updated

Property Value

DateTime

See Also

ListAgent