540co/ads-bpa

View on GitHub
server/docs/payloads/delete_reactions.md

Summary

Maintainability
Test Coverage
#DELETE /reactions/:reaction

The DELETE reactions endpoint will be used to delete a DRE reaction.

### Example Request Header
Here is an example header to insure the proper header values are being passed:

```
DELETE /api/reactions/death HTTP/1.1
Host: dre.540.co
```

### URL Parameters

Below is a list of URL parameters that may/must be passed to a request to this endpoint.

| Parameter | Required? | Type |  Description |
|-----------|-----------|------|--------------|
| reaction  | Yes       | URL Path | This field is a URL Encoded string of the medical reaction that is being deleted |

### Example Successful Response
Below is a response to a `DELETE` to the `/reactions/:reaction` API if none of the below error conditions has occurred and everything is `204 No Content`.  The response from a successful `DELETE` is empty.
```

```


### Error Response

Below is a table showing the errors that could be returned on the endpoint.

|Status Code | Description |
|------------|-------------|
| 400        | Invalid Request to DELETE endpoint. |


For more information on the format of the error responses please see the [API Error Response Page](./errors.md).