SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    Create a new ConsentPurpose list item

    Calls the List agent service SaveConsentPurpose.

    Input

    type: object properties: parameters: type: object properties: newEntity: description: "Carrier object for ConsentPurpose.\r\nServices for the ConsentPurpose Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>." type: object properties: ConsentPurposeId: format: int32 description: Primary key type: integer Name: description: Name of consent purpose type: string ConsentText: description: Form text used for the actual checkbox type: string FormText: description: >- Text for the consent form, the long text to be shown when asking the end-user for this kind of consent type: string Key: description: >- The key used to refer to this purpose, like #Process, #Emarketing etc. type: string Tooltip: description: List item tooltip type: string Active: format: int32 description: Is the consent purpose active or not type: integer UpdatedDate: format: date-time description: The date the consent purpose was last updated in UTC. type: string UpdatedBy: description: The associate that last updated the consent purpose type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Deleted: description: true if the ConsentPurpose is deleted type: boolean Rank: format: int32 description: Rank of this consent source type: integer PrivacyStatementDesc: description: Name or description for the privacy statement type: string PrivacyStatementUrl: description: Url referencing the actual privacy statement type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - newEntity title: Parameters