Class ConsentPurpose

Carrier object for ConsentPurpose. Services for the ConsentPurpose Carrier is available from the List Agent.

Inheritance
object
ConsentPurpose
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class ConsentPurpose : Carrier
Examples

Get ConsentPurpose 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ListAgent();
   var consentPurpose = agent.GetConsentPurpose( 123 );
}

Constructors

ConsentPurpose()

Default constructor

Declaration
public ConsentPurpose()
See Also

Properties

Active

Is the consent purpose active or not

Declaration
[DataMember]
public virtual short Active { get; set; }
Property Value
Type Description
short
See Also

ConsentPurposeId

Primary key

Declaration
[DataMember]
public virtual int ConsentPurposeId { get; set; }
Property Value
Type Description
int
See Also

ConsentText

Form text used for the actual checkbox

Declaration
[DataMember]
public virtual string ConsentText { get; set; }
Property Value
Type Description
string
See Also

Deleted

true if the ConsentPurpose is deleted

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also

FormText

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

Declaration
[DataMember]
public virtual string FormText { get; set; }
Property Value
Type Description
string
See Also

Key

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

Declaration
[DataMember]
public virtual string Key { get; set; }
Property Value
Type Description
string
See Also

Name

Name of consent purpose

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

PrivacyStatementDesc

Name or description for the privacy statement

Declaration
[DataMember]
public virtual string PrivacyStatementDesc { get; set; }
Property Value
Type Description
string
See Also

PrivacyStatementUrl

Url referencing the actual privacy statement

Declaration
[DataMember]
public virtual string PrivacyStatementUrl { get; set; }
Property Value
Type Description
string
See Also

Rank

Rank of this consent source

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also

Tooltip

List item tooltip

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also

UpdatedBy

The associate that last updated the consent purpose

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also

UpdatedDate

The date the consent purpose was last updated in UTC.

Declaration
[DataMember]
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also