Skip to content

Commit 2516dc6

Browse files
committed
add oas documentation for getMI endpoint
1 parent 8c3b890 commit 2516dc6

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

  • specification/api/components/documentation
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Overview
2+
3+
Use this endpoint to retrieve management or operational metrics relating to letter processing and print fulfilment.
4+
5+
When you submit a get management information request, the endpoint will respond with a 200 (Success) response code along with the created data including a unique id for the record or an unsuccessful (4xx/5xx) response.
6+
7+
Rate limiting applies. On excess requests, you may receive **429 Too Many Requests** (example error code(s): `NOTIFY_QUOTA`). Back off and retry later.
8+
9+
## Sandbox test scenarios
10+
11+
You can test the following scenarios in our sandbox environment.
12+
13+
|Scenario|Request|Response|
14+
|--------|-------|--------|
15+
|Success|Request for successful MI record retrieval| 200 (Success) with the retrieved management information in the response|
16+
|Invalid Request|Invalid Request for MI record retrieval| 400 (Bad Request) with the error details in the body|
17+
|Unknown specification|Request for MI record retrieval for unknown spec|404 (Not Found) with the error details in the body|

0 commit comments

Comments
 (0)