Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deceased API spec #1426

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Add deceased API spec #1426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/api-designs/deceased.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Deceased API

## `PUT` `/persons/deceased/<trn>`

Where `<trn>` 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.
Loading