Skip to content

Commit

Permalink
Amend awardedDate property on QTLS API spec to qtsDate (#1260)
Browse files Browse the repository at this point in the history
  • Loading branch information
gunndabad authored Apr 4, 2024
1 parent ff27b08 commit 7454321
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/api-designs/qtls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Add/remove QTLS API

Draft specification v0.1.
Draft specification v0.2.

There are two endpoints; one sets or removes the QTLS date for a person and another queries the existing QTLS status.
In all cases the person is identified by a TRN.
Expand All @@ -13,35 +13,35 @@ Response body structure:
```json
{
"trn": "",
"awardedDate": ""
"qtsDate": ""
}
```

The `awardedDate` property will be formatted `yyyy-MM-dd`. If the person does not have QTLS awarded then `awardedDate` will be `null`.
The `qtsDate` property will be formatted `yyyy-MM-dd`. If the person does not have QTLS awarded then `qtsDate` will be `null`.


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

Request body structure:
```json
{
"awardedDate": ""
"qtsDate": ""
}
```

If no record exists with the specified TRN, a `404 Not Found` status code will be returned.

The `awardedDate` property must be formatted `yyyy-MM-dd` or be `null`. The date cannot be in the future [TBD].
The `qtsDate` property must be formatted `yyyy-MM-dd` or be `null`. The date cannot be in the future [TBD].

If the `awardedDate` is not `null` then the QTLS status will be added or updated with the provided date.
If the `qtsDate` is not `null` then the QTLS status will be added or updated with the provided date.

If the `awardedDate` is `null` then any existing QTLS status on the teaching record will be removed.
If the `qtsDate` is `null` then any existing QTLS status on the teaching record will be removed.

Response body structure:
```json
{
"trn": "",
"awardedDate": ""
"qtsDate": ""
}
```

Expand Down

0 comments on commit 7454321

Please sign in to comment.