POST api/people/{id}/redact?note={note}&sendEmail={sendEmail}
Redact a Person by PersonId First request is just logged as an event Second request must be by a branch admin and actually redacts the person Only set sendEmail to false for internal bulk redact requests, the normal process requires an email. This will also suppress notifications to the negotiator. Processes this people API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
| note |
The note value supplied with the request. |
string |
Default value is |
| sendEmail |
The send email value supplied with the request. |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Details of the redation job
JobInvocationDetailsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SupportsCancellation |
Indicates whether supports cancellation is true. |
boolean |
None. |
| ReportsProgress |
Indicates whether reports progress is true. |
boolean |
None. |
| InitialStatusText |
The initial status text value. |
string |
None. |
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| Success |
Indicates whether success is true. |
boolean |
None. |
Response Formats
application/json, text/json
{
"SupportsCancellation": true,
"ReportsProgress": true,
"InitialStatusText": "sample string 3",
"JobReference": "cbcb765e-2187-454c-abda-c88433097549",
"Success": true
}