Endpoints ‐ Filings

• GET /v1/filing/institutions/{lei}/filings/{period_name} - Returns Filing JSON for the passed in LEI and period code.
  • See sequence Sequences ‐ Get Filing
  • If no filing started, returns a 204 NO_CONTENT
• POST /v1/filing/institutions/{lei}/filings/{period_name} - Returns newly created Filing JSON for the passed in LEI and period code.
  • No body is expected here, however the code currently supports receiving a FilingDTO so if the frontend wants to send a JSON object with lei, filing_period and potentially institution_snapshot_id, this could be done to start the Filing.
  • 409 CONFLICT code is returned if a POST is made for an existing Filing
• POST /v1/filing/institutions/{lei}/filings/{period_name}/sign - 'Signs' the Filing based on passed in filing id. Returns a Filing JSON with confirmation ID.
  • See sequence Sequences ‐ Sign Filing

Need to have further discussion on PUT endpoint. The following approaches are considered:

• PUT /v1/filing/institutions/{lei}/filings/{period_name} - Takes in a JSON object with just the field being updated, for example {"institution_snapshot_id":"v2"}
  • This requires the FilingDTO to have fields as optional, which may not be desired, if we use the same DTO for PUT and GET
  • Use a FilingPatchDTO that is identical in fields to the FilingDTO, but all fields are optional
• PUT /v1/filing/institutions/{lei}/filings/{period_name}/fields/{field_name} - This uses path variables to update the FilingDAO, and takes a JSON object of {"value": "Some new value"}
  • Example, /v1/filing/institutions/1234567890/filings/2024/fields/institution_snapshot_id with body {"values":"v2"}