This is a backend microservice for managing relationships between agent and client for the PERSONAL-INCOME-RECORD service. It allows you to retrieve information about agent-client relationships, create and delete. This service has an isolated relationship store from other supported services (ITSA and VAT), which it uses to manage relationships rather than calling a DES API.
To run the application execute
sbt run
sm --start AGENT_FI_ALL
Running locally, the services will run on http://localhost:9427
POST /agent-fi-relationship/relationships/agent/:arn/service/:service/client/:clientId
Response Code(s)
| Status Code | Description |
|---|---|
| 201 | Relationship created |
GET /agent-fi-relationship/relationships/agent/:arn/service/:service/client/:clientId
Result
[
{
"arn": "AARN123",
"service": "service123",
"clientId": "clientId123",
"relationshipStatus": "Active"
}
]
Response Code(s)
| Status Code | Description |
|---|---|
| 201 | Relationship found and returned |
| 404 | Relationship not found |
GET /agent-fi-relationship/relationships/service/:service/clientId/:clientId
Result
[
{
"service": "service123",
"clientId": "clientId123",
"relationshipStatus": "Active"
},
{...}
]
Response Code(s)
| Status Code | Description |
|---|---|
| 201 | Relationship found and returned |
| 404 | Relationship not found |
DELETE /agent-fi-relationship/relationships/agent/:arn/service/:service/client/:clientId
Response Code(s)
| Status Code | Description |
|---|---|
| 200 | Relationship deleted |
DELETE /agent-fi-relationship/relationships/service/:service/clientId/:clientId
Response Code(s)
| Status Code | Description |
|---|---|
| 200 | Relationships deleted |
GET /agent-fi-relationship/relationships/afi/agent/:arn/client/:clientId
Result
[
{
"arn": "AAABBB111222",
"service": "afi",
"clientId": "123456",
"relationshipStatus": "Active"
}
]
Response Code(s)
| Status Code | Description |
|---|---|
| 201 | Relationship found |
| 404 | Relationship not found |
This code is open source software licensed under the Apache 2.0 License
