agent-client-relationships
This is a backend micro-service whose domain is Agent Client Relationships. It is used to manage relationships between agents and clients for the following services:
- HMRC-MTD-IT
- HMRC-MTD-VAT
- HMRC-TERS-ORG
- IR-SA
- HMCE-VATDEC-ORG
Running the tests
sbt test it:test
Running the app locally
sm --start AGENT_AUTHORISATION -r
sm --stop AGENT_CLIENT_RELATIONSHIPS
./run-local
Design Documentation
Recovery from Failures whilst Creating Relationships.
API
Check whether a relationship exists between an Agent and a client
GET /agent/:arn/service/:service/client/:clientIdType/:clientId
Possible responses:
OK - If the agent is allocated to the client then a 200 OK response with no JSON body will be returned
Not Found - If the agent is not allocated to the client then a 404 Not Found will be returned with a JSON structure as follows:
{
"code": "RELATIONSHIP_NOT_FOUND"
}
The provided error code is to help diagnose potential issues in production and will usually be "RELATIONSHIP_NOT_FOUND".
Create relationship exists between an Agent and a client
PUT /agent/:arn/service/:service/client/:clientIdType/:clientId
Possible responses :
Created - If the agent is allocated to the client then a 201 Created will be returned with an empty body
NotFound - If the relationship could not be created then 404 NotFound will be returned with the failure message
as body to help diagnose the issue
Delete a relationship exists between an Agent and a client
DELETE /agent/:arn/service/:service/client/:clientIdType/:clientId
Possible responses:
NoContent - If the agent is de allocated from the client then a 204 NoContent will be returned with empty body
Not Found - If de allocation fails then a 404 NotFound will be returned with a JSON structure as follows:
{
"code": "RELATIONSHIP_NOT_FOUND"
}
The provided error code is to help diagnose potential issues in production and will usually be "RELATIONSHIP_NOT_FOUND".
The valid combinations for service and clientIdTypes for GET/PUT/DELETE endpoints are as follows:
| Service | ClientIdType |
|---|---|
| HMRC-MTD-IT | MTDITID or NI |
| HMRC-MTD-VAT | VRN |
| HMRC-TERS-ORG | SAUTR |
| IR-SA | ni |
| HMCE-VATDEC-ORG | vrn |
License
This code is open source software licensed under the Apache 2.0 License