GDPR Plugin New Endpoints

Here you will find the new endpoints and the new location for the plugin in the admin console.

To find the GDPR plugin in the admin console, navigate to Plugins > GDPR Compliance Kit.

There are five more specific new endpoints related to the GDPR plugin. Below are descriptions of the new endpoints and what you should expect to be able to do with them.

📘

GDPR Endpoints are updated in the 2.3.1 and later versions of AnswerHub

To view the endpoints and more technical information related to the API, visit the References for GDPR Endpoints. Scroll down to the GDPR category to see all GDPR endpoints.

GET Request To Retrieve User ID From Email

This endpoint retrieves user ID information based on their email address.

  1. One Sample Request
  2. Two Expected Responses:
    a. Successful: 200
    b. Error: 422

POST Request To Upload A CSV File

This endpoint allows an admin/super user to upload a CSV file of users for a bulk GDPR job.

  1. Several Sample Request Types:
    a. Upload using only emails
    b. Upload using only user IDs
    c. Upload using only usernames
    d. Upload using only usernames and IDs
  2. Two Expected Responses:
    a. Successful: 201
    b. Error: 400

GET Requests To Retrieve A Scheduled Job ID

This endpoint allows a user to retrieve the job ID for a scheduled GDPR job.

  1. One Sample Request
  2. Four Expected Responses
    a. Two Successful: 200
    1. Pending Job
    2. Finished Job
      b. Two Errors
    3. Not Found
    4. Bad Request

POST Request To Schedule A Timed Job

This endpoint is used to schedule an individual or a group of individuals for a GDPR job.

  1. Two Different Types of Sample Requests
    a. Bulk Operation
    b. Individual Operation

📘

NOTES TO PAY ATTENTION TO FOR REQUESTS:

  1. You need one of the optional keys for the “user” object.
  • There are four operation types to choose from.
  1. Note the Formats for Dates and timeStamps
  • There are two options:
    a. “Formatted”: Month/day/year hour:second
    b. “timeStamp”: Time in milliseconds
  1. One Successful Response Expected: 201
  2. Eight Different Error Responses Expected:
    a. No user selected: HTTP/1.1 400 Bad Request
    b. File ID not specified: HTTP/1.1 400 Bad Request
    c. File ID does not exist: HTTP/1.1 400 Bad Request
    d. There is a job already scheduled for that timeframe: HTTP/1.1 400 Bad Request
    e. The selected date is not eligible: HTTP/1.1 400 Bad Request
    f. Empty operations list was submitted: HTTP/1.1 400 Bad Request
    g. Reassign user with more than one way of identifying who they are.
    (eg:"reassignUser" : {"id" : 7, "username" : "piero"}) HTTP/1.1 400 Bad Request
    h. The reassign user does not exist: HTTP/1.1 400 Bad Request

DELETE Request To Delete A Scheduled Job By ID

This endpoint is used to delete a pending scheduled GDPR job by the ID.

  1. One Sample Request
  2. One Successful Response Expected : 200
  3. Three Error Responses Expected:
    a. Job already ran or running: HTTP/1.1 422 Unprocessable Entity
    b. Job does not exist / already deleted HTTP/1.1 404 Not Found
    c. Job id invalid (eg: /v2/jobs/gdpr/511s.json ) HTTP/1.1 400 Bad Request

Did this page help you?