Sign in

Objection request schema

Requests

This section specifies the request section of the schema for objection requests

Field Type Description Comments
purposes JSON object A JSON object defining the purposes, data items and third parties structure the user is objection to, including a specific reason for objection  

This section specifies the purposes section of the schema for objection requests

Field Type Description Comments
referenceId string The internal identifier your service has for this item.
purposeId string The internal ID for this purpose
dataGroups JSON object A list of data objects linked to this purpose See own schema for this section below
processors JSON object An array of JSON objects containing the parties that are processors of personal data related to this processing purpose and being objected to See own schema for this section below
recipients JSON object An array of JSON objects containing the parties that are recipients of personal data related to this processing purpose and being objected to See own schema for this section below
version string Version of this purpose
reason string The reason supplied by the end user for objecting to this purpose  

This section specifies the dataGroups part of the schema

Field Type Description Comments
dataGroupId string The internal ID for this data group
referenceId string The internal identifier your service has for this data group.  

This section specifies the processors and recipients part of the schema

Field Type Description Comments
partyId string The internal ID for this party
referenceId string The internal identifier your service has for this party.  

Responses

This section specifies the response section of the schema for objection requests

Field Type Description Comments
objectionStatus string The status of the objection that is set after the request has been processed.
message string The message to be supplied to the user that has made the request  

Example payloads (from client to DPS)

POST /privacy/v2/projects/{project_id}/objections

{

  "identityId": "83f1b228-ec62-4605-810c-1b6b5e912818",
  "requested": "2017-11-21T12:52:24.320+01:00",
  "meta": {
    "requestedBy": "83f1b228-ec62-4605-810c-1b6b5e912818",
    "context": {
      "collectionMethod": "webform",
      "application": "Ü portal",
      "language": "en-AU",
      "internalReference": "none"
    }
  },
  "request": {
   "reason": "I object to Telia using my personal data for...",
   "purposes": [
     {
       "version": "1.2.0",
       "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
       "dataGroups": [
         {
           "dataGroupId": "11d58537-ade6-4019-a9a5-351233a90712",
         }
       ],
       "processors": [
         {
           "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
         }
       ],
       "recipients": [
         {
           "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646"
         }
       ]
     }
   ]
 }
}
GET /privacy/v2/projects/{project_id}/objections/{request_id}

{
  "projectId": "7fba66c8-9a67-4a06-8d70-7e5dffe9109d",
  "requestId": "73ba6e5dffe9109d",
  "status": "completed",
  "identityId": "83f1b228-ec62-4605-810c-1b6b5e912818",
  "requested": "2017-11-21T12:52:24.320+01:00",
  "created": "2017-11-21T12:52:24.320+01:00",
  "updated": "2017-11-21T12:52:24.320+01:00",
  "meta": {
    "requestedBy": "83f1b228-ec62-4605-810c-1b6b5e912818",
    "context": {
      "collectionMethod": "webform",
      "application": "Ü portal",
      "language": "en-AU",
      "internalReference": "none"
    }
  },
  "request": {
    "reason": "I object to Telia using my personal data for...",
    "purposes": [
      {
        "purposeId": "9d5df04e-3e7c-46a5-9440-8114206dcb52",
        "referenceId": "anIdentifier",
        "dataGroups": [
          {
            "dataGroupId": "11d58537-ade6-4019-a9a5-351233a90712",
            "referenceId": "anIdentifier"
          }
        ],
        "processors": [
          {
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646",
            "referenceId": "anIdentifier"
          }
        ],
        "recipients": [
          {
            "partyId": "3a8c23ab-d171-404f-9fd7-b13f1283f646",
            "referenceId": "anIdentifier"
          }
        ],
        "version": "1.2.0"
      }
    ]
  },
  "response": {
    "objectionStatus": "approved",
    "message": "OK"
  }
}
PUT ../objections/{request\_id}

{
  "status": "completed",
  "response": {
    "objectionStatus": "approved",
    "message": "Fine, whatever..."
  }
}