Change Request: updated query params, filters for settlement resources
partiallyordered opened this issue · comments
Open API for FSP Interoperability - Change Request
Table of Contents
1. Preface
___This section contains basic information regarding the change request.
1.1 Change Request Information
| Requested By | Matt Kingston |
| Change Request Status | In review ☒ / Approved ☐ / Rejected ☐ |
| Approved/Rejected Date | |
1.2 Document Version Information
| Version | Date | Author | Change Description |
|---|---|---|---|
| 1.0 | 2021-11-05 | Matt Kingston | Initial version. Sent out for review. |
2. Problem Description
___2.1 Background
When retrieving settlement information, it is desirable to include multiple parameters in filters in order to more efficiently retrieve settlements.
2.2 Current Behaviour
In order to retrieve settlements containing multiple accounts, participants, states, or windows, a user must make multiple requests. Example:
GET /v2/settlements?accountId=1
GET /v2/settlements?accountId=2
GET /v2/settlements?accountId=3
2.3 Requested Behaviour
GET /v2/settlements?accountId=1,2,3
Should return the aggregated results that would have been returned from the current behaviour, when making three separate requests. Similarly with other query parameters.
3. Proposed Solution Options
@partiallyordered thanks for the CR. @mdebarros hoping you can add this to the Agenda for the next week SIG meeting..
Attendees of the meeting on 2021-11-10 @ 14h00 GMT:
- @elnyry-sam-k (Admin/Settlement API SIG Member)
- @matdehaast (Guest)
- @mdebarros(Admin/Settlement API SIG Member)
- @MichaelJBRichards (Admin/Settlement API SIG Member)
- @PaulGregoryBaker (Admin/Settlement API SIG Member)
Quorum has accepted this change and the proposed changes to the API Interface Spec for the Settlement's API by the following members: