Skip to content

Commit

Permalink
APID-79: update README with information about retrying behaviour (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
worthydolt authored Feb 12, 2021
1 parent f6f44db commit 8617f9a
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# api-platform-outbound-soap

This service allows other HMRC services to send messages to external SOAP web services.
This service allows other HMRC services to send messages to external SOAP web services. It has a retry mechanism whereby if the
CCN2 SOAP service doesn't return a 2xx response, the request will be retried every 60 seconds for 5 minutes by default.
The total duration and the interval are both configurable.

## `POST /message`
Send a SOAP message for the given operation
Expand Down Expand Up @@ -57,7 +59,7 @@ HTTP Status: 200 (OK)
| --- | --- |
| `globalId` | Unique identifier allocated to the request when it is received |
| `messageId` | This optional property, if present, is the value provided by the `addressing.messageId` property of the request|
| `status` | Either `SENT` if the response from the SOAP service was 2xx or `FAILED` otherwise|
| `status` | One of `SENT` if the response from the SOAP service was 2xx, `RETRYING` if an error response was received from the SOAP service, or `FAILED` if all retries have been exhausted|

### Error scenarios
| Scenario | HTTP Status |
Expand Down

0 comments on commit 8617f9a

Please sign in to comment.