Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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/tests/post_v1_message-batches/happy_path.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
## 201 - Success


### Scenario: An API consumer creating a message that has a terminal status of FAILED

**Given** the API consumer provides details for an unreachable recipient in their new message
<br/>
**When** the request is submitted
<br/>
**Then** the response is a 201 success
<br/>

**Asserts**
- Response returns a 201 status code
- Response body matches expected result
- Response contains correctly formatted link to new message URI
- Message in NHS Notify reaches terminal status of FAILED
- Message has expected failure reason and code
- Channel has expected failure reason and code


### Scenario: An API consumer creating a batch of messages with an undefined NHS number receives a 201 response

**Given** the API consumer does not provide an NHS number for a recipient in their new message batch and the allowAnonymousPatient flag is set to true
Expand Down
18 changes: 18 additions & 0 deletions docs/tests/post_v1_single-message/happy_path.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
These tests target the API endpoint POST /v1/messages testing successful responses when valid data is provided.


## Scenario: An API consumer creating a message that has a terminal status of FAILED

**Given** the API consumer provides details for an unreachable recipient in their new message
<br/>
**When** the request is submitted
<br/>
**Then** the response is a 201 success
<br/>

**Asserts**
- Response returns a 201 status code
- Response body matches expected result
- Response contains correctly formatted link to new message URI
- Message in NHS Notify reaches terminal status of FAILED
- Message has expected failure reason and code
- Channel has expected failure reason and code


## Scenario: An API consumer creating a message with an undefined NHS number receives a 201 response

**Given** the API consumer does not provide an NHS number for the recipient in their new message and the allowAnonymousPatient flag is set to true
Expand Down
Loading