From 938e1491b5bafae74febb85d32ee102c49f064ac Mon Sep 17 00:00:00 2001 From: James Gunn Date: Fri, 19 Jul 2024 11:00:54 +0100 Subject: [PATCH] Add deceased API spec --- docs/api-designs/deceased.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/api-designs/deceased.md diff --git a/docs/api-designs/deceased.md b/docs/api-designs/deceased.md new file mode 100644 index 000000000..bd34e99cd --- /dev/null +++ b/docs/api-designs/deceased.md @@ -0,0 +1,18 @@ +# Deceased API + +## `PUT` `/persons/deceased/` + +Where `` is the person's TRN. + +Request body structure: +```json +{ + "dateOfDeath": "" +} +``` + +The `dateOfDeath` property is mandatory and should be formatted `yyyy-MM-dd`. + +If no record exists with the specified TRN, a `404 Not Found` status code will be returned. + +If the request is valid, a `204 No Content` status code will be returned.