GetRequestResponse
result objectrequired
requestidrequestId (string)
ID of the erasure request
Example:
OP-1234-5678-9101statusstatus (string)
The status of the erasure request.
Possible values: [Pending, In Progress, Complete, Failed, Completed Search]
Example:
In ProgressuserUser (string)
The userid of the user who requested the erasures.
Example:
example@qualtrics.comnumEmailsRequestedinteger<int64>
The number of emails for which erasure is requested
Example:
10emailsNotFoundEmail (string)[]
The number of emails requested but not found.
Example:
["test1@qualtrics.com","test2@qualtrics.com"]emailListemail (string)[]
The list of emails requested to be be erased.
Example:
["test1@qualtrics.com","test2@qualtrics.com"]searchOnlysearchOnly. this should be fixed to boolean to be consistent with request (string)
Indicates whether this was a dry run or not. If true, then no emails were erased.
failureReasonfailure reason (string)
If the status is failuer, the reason for the failure will be here.
createdstring<date-time>
The date and time the erasure request was created.
Example:
2018-04-01T09:00:00Zupdatedstring<date-time>
The date and time when the erasure request was last updated.
Example:
2018-04-01T09:00:00Zmeta objectrequired
httpStatusHttp status code (string)required
requestIdrequestId (string)required
noticeAn informational string about the request. (string)
GetRequestResponse
{
"result": {
"requestid": "OP-1234-5678-9101",
"status": "In Progress",
"user": "example@qualtrics.com",
"numEmailsRequested": 10,
"emailsNotFound": [
"test1@qualtrics.com",
"test2@qualtrics.com"
],
"emailList": [
"test1@qualtrics.com",
"test2@qualtrics.com"
],
"searchOnly": "string",
"failureReason": "string",
"created": "2018-04-01T09:00:00Z",
"updated": "2018-04-01T09:00:00Z"
},
"meta": {
"httpStatus": "string",
"requestId": "string",
"notice": "string"
}
}