Developers
Purposes, codes and notice versions
Choices are made purpose by purpose, against a published version of the notice.
Developer pages and contents
Purposes
- code
- 2 to 31 characters: small letters, digits and hyphens, starting with a letter (
^[a-z][a-z0-9-]{1,30}$). It never changes once made. - title, description
- What the purpose is, in plain words. These can change.
- dataItems
- The personal data the purpose uses: 1 to 30 items.
- retentionDays
- The keep-for period in days (1 to 36500), or none.
- required
- Shown to the person as needed for the service.
Templates add purposes with fixed codes, such as service, billing, statutory, updates, support, marketing and feedback. Use the codes your workspace shows.
Notice versions
- Each language has its own notice and its own version numbers.
- You edit a draft and publish it. Publishing copies the active purposes into the notice as they stand, keeps its hash, and retires the version published before it in that language.
- A published notice never changes. Each one has its own id.
- Every choice names the notice it was made against.
After you publish a new version, calls that send the old
noticeId are refused with notice_changed. Read the current notice and ask again. The widget asks visitors again by itself.Reading the current notice
Shell
curl "https://api.dpdpgrid.in/api/public/consent/AbCdEf123456?lang=hi"notice.id is the id to send, and notice.purposes[].code the codes. With no notice in the language asked for, the English one comes back, or the first published. See the full response.
Keep-for periods
When a purpose has a keep-for period, the person is told 48 hours before it ends, where their e-mail or mobile is known. When it ends, the consent is recorded as EXPIRED and an erasure is due.
A withdrawal also puts an erasure for that purpose on the workspace's list.
Languages
| Code | Language |
|---|---|
en | English |
as | Assamese |
bn | Bengali |
brx | Bodo |
doi | Dogri |
gu | Gujarati |
hi | Hindi |
kn | Kannada |
ks | Kashmiri (right to left) |
kok | Konkani |
mai | Maithili |
ml | Malayalam |
mni | Manipuri |
mr | Marathi |
ne | Nepali |
or | Odia |
pa | Punjabi |
sa | Sanskrit |
sat | Santali |
sd | Sindhi (right to left) |
ta | Tamil |
te | Telugu |
ur | Urdu (right to left) |