Skip to content

Commit

Permalink
few corrections in readme and MatchType
Browse files Browse the repository at this point in the history
  • Loading branch information
lalithanagarur committed Mar 10, 2025
1 parent 2ece9e3 commit 724e9f2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 42 deletions.
45 changes: 4 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,8 @@ The match will be saved as a `MatchEntity` in the database.
"matchingUln": "1234567890",
"givenName": "John",
"familyName": "Smith",
"matchType": "POSSIBLE_MATCH",
"countOfReturnedULNs": "2"
"matchType": "Possible match",
"countOfReturnedUlns": "2"
}
</pre>
</details>
Expand All @@ -287,8 +287,8 @@ The match will be saved as a `MatchEntity` in the database.
<br>
<pre>
{
"matchType": "NO_MATCH_RETURNED_FROM_LRS",
"countOfReturnedULNs": "0"
"matchType": "No match returned from LRS",
"countOfReturnedUlns": "0"
}
</pre>
</details>
Expand All @@ -300,43 +300,6 @@ Response codes:
* 403 - Forbidden
* 500 - Likely that the database is unreachable

### `POST:/match/:nomisId`
This endpoint is to confirm a match between a learner's NOMIS ID and ULN.
The givenName and familyName should be as per the LRS data for a match.
The match will be saved as a `MatchEntity` in the database.

<details>
<summary>Example request body for a match:</summary>
<br>
<pre>
{
"matchingUln": "1234567890",
"givenName": "John",
"familyName": "Smith",
"matchType": "POSSIBLE_MATCH",
"countOfReturnedULNs": "2"
}
</pre>
</details>

<details>
<summary>Example request body for a no match:</summary>
<br>
<pre>
{
"matchType": "NO_MATCH_SELECTED",
"countOfReturnedULNs": "6"
}
</pre>
</details>

Response codes:
* 201 - Created
* 400 - Bad Request, malformed ULN or json body
* 401 - Unauthorised
* 403 - Forbidden
* 500 - Likely that the database is unreachable

### `GET:/match/:nomisId`
This endpoint is to search the database for a match given a NOMIS ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ enum class MatchType(val description: String) {
NO_MATCH_RETURNED_FROM_LRS("No match returned from LRS"),
EXACT_MATCH("Exact match"),
POSSIBLE_MATCH("Possible match"),
LINKED_LEARNER_MATCH("linked learner match"),
LINKED_LEARNER_MATCH("Linked learner match"),
TOO_MANY_RESULTS("Too many results"),
;

Expand Down

0 comments on commit 724e9f2

Please sign in to comment.