Applications.PersonalData.ProcessingConsents Entity

Namespace: Applications.PersonalData

Consents of data subjects for processing of their personal data. Entity: Pdm_Processing_Consents (Introduced in version 18.2)

Default Visualization

Default Display Text Format:
{ParentName}
Default Search Members:
ParentName
Name Data Member:
ParentName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Applications.PersonalData.ProcessingConsents

Attributes

Name	Type	Description
AllowAddress	boolean	Allows the processing of the physical address. `Required` `Default(false)` `Filter(eq)`
AllowBasicData	boolean	Allows the processing of basic (usually public) data: Name, AgeGroup21+, public profile picture, etc. `Required` `Default(false)` `Filter(eq)`
AllowEmail	boolean	Allows the processing of the email address. `Required` `Default(false)` `Filter(eq)`
AllowOtherData	string (max) nullable	Comma-separated list of other types of data, which was allowed for processing with this consent. `Filter(eq)`
AllowPhone	boolean	Allows the processing of the telephone number. `Required` `Default(false)` `Filter(eq)`
ConsentImage	byte[] nullable	If not null, it is a graphical image, containing additional information for the consent.
ConsentText	string (max) nullable	The actual text of the consent. `Filter(like)`
ConsentType	ConsentType	The way the consent was given. O=Online; I=Implicit; V=Verbal; W=Written; E=Email; T=Other (should be stated in Notes). `Required` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
GivenOnUtc	datetime	The date and time (in Utc), when the consent was given. `Required` `Filter(ge;le)`
Id	guid
IsActive	boolean	Whether the consent is active or retracted. Once retracted, the consent record cannot be modified again and a new consent should be given. `Required` `Default(true)` `Filter(eq)`
IsChild	boolean	Specifies whether the data subject is child, according to the local regulations. General regulations treat all persons below the age of 16 as child. `Required` `Default(false)` `Filter(eq)`
Notes	string (max) nullable	Notes for this ProcessingConsent.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ParentEmail	string (50) nullable	When a parental rights holder gives a consent for a child, contains the email of the parent. `Filter(like)`
ParentName	string (50) nullable	When a parental rights holder gives a consent for a child, contains the name of the parent. `Filter(eq;like)`
ParentPhone	string (50) nullable	When a parental rights holder gives a consent for a child, contains the phone number of the parent. `Filter(like)`
RetractedOnUtc	datetime nullable	The date and time (in Utc), when the consent was retracted. Null if the consent is not retracted. `Filter(ge;le)`

References

Name	Type	Description
Person	Persons (nullable)	The person, for which the consent is given. Null when the consent is given by an online user, which is still not linked to a specific person record. `Filter(multi eq)`
PersonalDataProcess	PersonalDataProcesses (nullable)	The process, which will be used to process the data. Null when the process is unknown, or there are multiple processes (not recommended) processing the data, listed in the Notes. `Filter(multi eq)`
User	Users	The login user, for which the consent is given. Null when a consent is entered for a natural person, not through online user. `Required` `Filter(multi eq)`

Attribute Details

AllowAddress

Allows the processing of the physical address. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

AllowBasicData

Allows the processing of basic (usually public) data: Name, AgeGroup21+, public profile picture, etc. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

AllowEmail

Allows the processing of the email address. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

AllowOtherData

Comma-separated list of other types of data, which was allowed for processing with this consent. Filter(eq)

Type: string (max) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

AllowPhone

Allows the processing of the telephone number. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

ConsentImage

If not null, it is a graphical image, containing additional information for the consent.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ConsentText

The actual text of the consent. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ConsentType

The way the consent was given. O=Online; I=Implicit; V=Verbal; W=Written; E=Email; T=Other (should be stated in Notes). Required Filter(eq)

Type: ConsentType
Category: System
Allowed values for the ConsentType(Applications.PersonalData.ProcessingConsents.md#consenttype) data attribute
Allowed Values (Applications.PersonalData.ProcessingConsentsRepository.ConsentType Enum Members)

Value	Description
Online	Online value. Stored as 'O'. Database Value: 'O' Model Value: 0 Domain API Value: 'Online'
Implicit	Implicit value. Stored as 'I'. Database Value: 'I' Model Value: 1 Domain API Value: 'Implicit'
Verbal	Verbal value. Stored as 'V'. Database Value: 'V' Model Value: 2 Domain API Value: 'Verbal'
Written	Written value. Stored as 'W'. Database Value: 'W' Model Value: 3 Domain API Value: 'Written'
Email	Email value. Stored as 'E'. Database Value: 'E' Model Value: 4 Domain API Value: 'Email'
Other	Other value. Stored as 'T'. Database Value: 'T' Model Value: 5 Domain API Value: 'Other'

Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

GivenOnUtc

The date and time (in Utc), when the consent was given. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Whether the consent is active or retracted. Once retracted, the consent record cannot be modified again and a new consent should be given. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

IsChild

Specifies whether the data subject is child, according to the local regulations. General regulations treat all persons below the age of 16 as child. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Notes

Notes for this ProcessingConsent.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ParentEmail

When a parental rights holder gives a consent for a child, contains the email of the parent. Filter(like)

Type: string (50) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 50
Show in UI: ShownByDefault

ParentName

When a parental rights holder gives a consent for a child, contains the name of the parent. Filter(eq;like)

Type: string (50) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 50
Show in UI: ShownByDefault

ParentPhone

When a parental rights holder gives a consent for a child, contains the phone number of the parent. Filter(like)

Type: string (50) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 50
Show in UI: ShownByDefault

RetractedOnUtc

The date and time (in Utc), when the consent was retracted. Null if the consent is not retracted. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Person

The person, for which the consent is given. Null when the consent is given by an online user, which is still not linked to a specific person record. Filter(multi eq)

Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PersonalDataProcess

The process, which will be used to process the data. Null when the process is unknown, or there are multiple processes (not recommended) processing the data, listed in the Notes. Filter(multi eq)

Type: PersonalDataProcesses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

User

The login user, for which the consent is given. Null when a consent is entered for a natural person, not through online user. Required Filter(multi eq)

Type: Users
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_PersonalData_ProcessingConsents?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_PersonalData_ProcessingConsents?$top=10

Table of Contents

Applications.PersonalData.ProcessingConsents Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

AllowAddress

AllowBasicData

AllowEmail

AllowOtherData

AllowPhone

ConsentImage

ConsentText

ConsentType

DisplayText

GivenOnUtc

Id

IsActive

IsChild

Notes

ObjectVersion

ParentEmail

ParentName

ParentPhone

RetractedOnUtc

Reference Details

Person

PersonalDataProcess

User

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API