PUT /external/schedule/{externalId}/anonymize/mark
The {externalId} in the URL is the external id of an archived schedule (unless forceArchive=true) with all results published, i.e. for all candidates.
This API call allows you to mark a schedule for anonymization.
More info on Schedule Anonymization
We kindly refer you to the Anonymization of candidate exam results section of our Anonymization of personal data page in the Knowledge Base for more details.
Anonymization Activation
Anonymization needs to be activated
Please request the Anonymization to be activated for your Cirrus environment(s) by our Technical Support (as long as there is no UI in Cirrus).
Request
Always include the required HTTP Headers
Apart from {externalId} in the URL there is one optional parameter:
| Name | Data Type |
Description |
|---|---|---|
| forceArchive | boolean | If true, a schedule will be archived first. If false, the schedule must already be archived, see also /archive |
Sample Request
PUT https://api.cirrusplatform.com/api/v1/integrations/external/schedule/EXT_sch_1/anonymize/mark
Sample Response
{
"IsAnonymized": true,
"AnonymizationDate": "DD-MM-YYYYThh:mm:ss.xxxZ",
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 321 | Anonymization not supported. See Anonymization Activation |
| 322 | Cannot anonymize draft schedule > a draft schedule is not planned yet and thus no data to anonymize |
| 323 | Cannot anonymize active schedule > schedule needs to be archived first, or use forceArchive=true |
| 324 | Cannot anonymize schedule with unpublished results |
| 325 | Schedule has already been marked for anonymization |
| 326 | Schedule has already been anonymized |
| 327 | Schedule not marked for anonymization |
| 403 | Not allowed to use external API |
| 500 | Internal server error |