Privacy / GDPR
==============

``/api/v1/$FLOCK/user/hosted/privacy/``

The hosted privacy calls provides all the data needed to build a privacy page.

.. code-block:: http

    http GET https://api.sheepcrm.com/api/v1/$FLOCK/user/hosted/privacy/ 
    HTTP/1.1 200 OK
	{
	    "address_lines": [
	        "1 Pretend Street",
	        "Pretendsville",
	        "Utah"
	    ],
	    "consent_list": [
	        {
	            "channels": [
	                "email"
	            ],
	            "cid": "c000",
	            "context": "What’s On Newsletter",
	            "purpose": "Live Programme Newsletter"
	        },
	        {
	            "channels": [
	                "email",
	                "phone",
	                "post"
	            ],
	            "cid": "c001",
	            "context": "Bothering phonecalls and letters",
	            "purpose": "To bother you"
	        }
	    ],
	    "email": "fake@example.com",
	    "flock": "example",
	    "flockNamePublic": "My Community Trust",
	    "flockNamePublicShort": "MCT",
	    "how_to_contact_us_intro": "You can't contact us, because we're not a real organisation, but if we were you could use some details like these.",
	    "how_we_collect": [
	        "you send us an email",
	        "you sign up as a member",
	        "you make a donation",
	        "you volunteer",
	        "you sign up to a mailing list online"
	    ],
	    "how_we_collect_intro": "We collect personal information directly from you when:",
	    "name_in_logo": false,
	    "other_questions_contact": "If you do not want us to use your data in this way, wish to stop receiving communications from us or have any other questions please email us at [myprivacy@sheepcrm.com](mailto:myprivacy@sheepcrm.com?subject=I have a question about the personal information you hold for me)",
	    "palette": {	       
	    },
	    "phone": "01234 567 890",
	    "privacy_intro": "We take privacy very seriously and want to ensure your personal data is cared for correctly and in line with the new General Data Protection Regulation (GDPR). The following page gives some information about how we care for your personal data followed by a short form which you can fill in to tell us how you would like us to communicate with you.",	   
	    "website": "https://www.sheepcrm.com/",
	    "what_we_collect": [
	        "contact details and personal information to enable us to plan, organise and manage our annual festival and year round events and keep you up to date with news and other information ",
	        "financial information relating to payments for tickets and merchandise and donations to enable such payments and donations (including Gift Aid applications) to be processed. "
	    ],
	    "what_we_collect_intro": "We collect the following information:",
	    "why_we_collect": [
	        "To build up a picture of our customer/supporter profile;",
	        "To keep you up to date with news of our events, activities and other information;",
	        "To process a payment that you have made for tickets or merchandise;",
	        "To process a donation that you have made (including Gift Aid information); ",
	        "To manage our employees and volunteers; ",
	        "To maintain our own accounts and records;",
	        "To process a grant;",
	        "To process an application for a role."
	    ],
	    "why_we_collect_intro": "We use your personal data for the following purposes:"
	}


Fresh Consent
--------------

``/api/v1/$FLOCK/user/consent/``
	
POST a public fresh consent submission (person + consent data). Sheep will find or create the contact and add the consent records.
 

Payload fields for finding or creating a person:

	- title
	- first_name
	- last_name
	- date_of_birth
	- email (required)
	- postal_code

Consents to set are each represented by a separate composite field e.g. ``consent__c001__post`` The field name has three parts separated by double underscores ``__``. The first sub-field is always ``consent`` the second is the ID of the consent and the third field is the consent channel (e.g. email, sms, post). The value of the field should be set to ``True`` (don't include consents which have not been granted and don't try withdrawing consent with a False value.) 

NOTE: Use the hosted privacy call to get the consent IDs (``cid``) needed for this call.

.. code-block:: http

	http POST https://api.sheepcrm.com/api/v1/$FLOCK/user/consent/ first_name=Jim last_name=Lovell email=jim@nasa.gov consent__c001__post=True
	HTTP/1.1 201 CREATED
    {
	    "consent_added": [
	        {
	            "channel": "post",
	            "context": "I provide consent for Example to process my data to send me electronic newsletters.",
	            "context_url": "Unknown",
	            "date": "2020-02-25T07:31:44.068904",
	            "purpose": "newsletter",
	            "reference": "/example/person/5e44020149c3a85acee1ff9b/",
	            "source": "Sheep App",
	            "source_reference": "fresh consent form"
	        }
	    ],
	    "errors": {},
	    "updates": {
	        "email": [
	            "jim@nasa.gov"
	        ],
	        "first_name": "Jim",
	        "last_name": "Lovell"
	    }
	}


Consents for a user
-------------------

``/api/v1/$FLOCK/user/{uid}/consent/``

[user auth required]

Get or update consents associated with the user account.

/api/v1/example/user/1cbd7f64ae/consent/


Withdraw Consent
-----------------

``/$FLOCK/user/{uid}/consent/{cuid}/withdraw/``

[user auth required]

PUT  - withdraw a consent