Delete SoR Role Flow

Overview

This document describes some sample flows for deleting a role from a person in the registry and a general explanation of the process.

A System of Record (SoR) may wish to delete a role from a person in the Registry. The following is an example request for SoR 123 to delete role 2  from a person known to the SoR as 124:

[https://test-registry.rutgers.edu/api/v1/sor/123/people/124/roles/2]

DELETE /api/v1/sor/123/people/124/roles/2 HTTP/1.1
Host: test-registry.rutgers.edu
Content-Type: application/xml
Authorization: Basic cmF0czpSQVQxMjM0

*Sample Response:*

HTTP/1.x 204 No Content

The role 2 associated with the SoR Person 124 will be deleted.

Deleting SoR Role Records to Correct a Mistake

SoR Role records may be deleted from the Registry because they were added by mistake. In the event that the person should never have been given the role, the delete request would look like this:

[https://test-registry.rutgers.edu/api/v1/sor/123/people/124/roles/2&mistake=true]

DELETE /api/v1/sor/123/people/124/roles/2&mistake=true HTTP/1.1
Host: test-registry.rutgers.edu
Content-Type: application/xml
Authorization: Basic cmF0czpSQVQxMjM0

*Sample Response:*

HTTP/1.x 204 No Content

When it is indicated that the delete is being done to correct a mistake, all traces of the role are removed from the person in the Registry.  When "mistake" is not indicated, some information about the role is retained.

Please see [http://www.ja-sig.org/wiki/display/ORUM/SoR+Role+Resource] for a detailed explanation of all possible return codes.