API Documentation

WebsiteAPI V1 - MailingPurposeConsentPrivate

Resource Details

                                URL: /WebsiteAPI/v1/MailingPurposeConsentPrivate/{purposeid}

                                Description: Private API resource which allows a user to view and add purpose consents while the contact is in the Access Charity CRM system (after verification)

                                Call type: Entity

                                Filter: 

                                Sort: 

                                GET: Allowed - Requires Authentication

                                POST: Allowed - Requires Authentication

                                PUT: Not Allowed

                                DELETE: Not Allowed

Fields

Field Name		Select By Default	Filterable	Sortable	Postable	Post Default Value	Putable
created						-
emailConsentStatus						-
	Validation (Rule - Message): Required Field - Please enter the Status for the Email consent. Please enter a Status that exists in the system for the Email consent.
emailExpiry						-
	Validation (Rule - Message): Must be a date - emailExpiry must be a valid date of format DD/MM/YYYY Required Field - Please enter the Expiry date for the Email consent.
emailModifiedBy						"Web"
	Validation (Rule - Message): Required Field - Please enter the Received By details for the Email consent.
emailNotes						-
emailReceived						-
	Validation (Rule - Message): Must be a date - emailReceived must be a valid date of format DD/MM/YYYY Required Field - Please enter the Received date for the Email consent.
emailSource						-
	Validation (Rule - Message): Required Field - Please enter Source for the Email consent. Please enter a Source Code that exists in the system for the Email consent.
importId						-
mailConsentStatus						-
	Validation (Rule - Message): Must be in the list of values - Invalid entry Required Field - Please enter the Status for the Mail consent. Please enter a Status that exists in the system for the Mail consent.
mailExpiry						-
	Validation (Rule - Message): Must be a date - mailExpiry must be a valid date of format DD/MM/YYYY Required Field - Please enter the Expiry date for the Mail consent.
mailModifiedBy						"Web"
	Validation (Rule - Message): Required Field - Please enter the Received By details for the Mail consent.
mailNotes						-
mailReceived						-
	Validation (Rule - Message): Must be a date - mailReceived must be a valid date of format DD/MM/YYYY Required Field - Please enter the Received date for the Mail consent.
mailSource						-
	Validation (Rule - Message): Please enter a Source Code that exists in the system for the Mail consent. Required Field - Please enter Source for the Mail consent.
modified						-
modifiedBy						-
phoneConsentStatus						-
	Validation (Rule - Message): Required Field - Please enter the Status for the Phone consent. Please enter a Status that exists in the system for the Phone consent.
phoneExpiry						-
	Validation (Rule - Message): Must be a date - phoneExpiry must be a valid date of format DD/MM/YYYY Required Field - Please enter the Expiry date for the Phone consent.
phoneModifiedBy						"Web"
	Validation (Rule - Message): Required Field - Please enter the Received By details for the Phone consent.
phoneNotes						-
phoneReceived						-
	Validation (Rule - Message): Must be a date - phoneReceived must be a valid date of format DD/MM/YYYY Required Field - Please enter the Received date for the Phone consent.
phoneSource						-
	Validation (Rule - Message): Required Field - Please enter Source for the Phone consent. Please enter a Source Code that exists in the system for the Phone consent.
purpose						-
	Validation (Rule - Message): Must be in the list of values - Invalid entry Required Field - Please enter the Purpose for the consent. This contact already has an entry for this consent purpose which will be replaced. Please enter a Purpose that exists in the system.
purposeId						-
serialNumber						-
	Validation (Rule - Message): Required Field - You must enter the serialNumber Please enter a valid Serial Number.
smsConsentStatus						-
	Validation (Rule - Message): Required Field - Please enter the Status for the SMS consent. Please enter a Status that exists in the system for the SMS consent.
smsExpiry						-
	Validation (Rule - Message): Must be a date - smsExpiry must be a valid date of format DD/MM/YYYY Required Field - Please enter the Expiry date for the SMS consent.
smsModifiedBy						"Web"
	Validation (Rule - Message): Required Field - Please enter the Received By details for the SMS consent.
smsNotes						-
smsReceived						-
	Validation (Rule - Message): Must be a date - smsReceived must be a valid date of format DD/MM/YYYY Required Field - Please enter the Received date for the SMS consent.
smsSource						-
	Validation (Rule - Message): Required Field - Please enter Source for the SMS consent. Please enter a Source Code that exists in the system for the SMS consent.