Provide a Summary API for Use in Entry Point Services

Outline

To provide an summary and overview of activity managed in another service, an entry point service must:

• Query for data relevant to a specific context (e.g probation case)
• Gather the details needed to provide the summary

To support these actions a service can provide a summary API to serve all required data in a single call

Rationale

Entry point services collate information from many sources and provide summary views and links to more detailed information and workflows. By supporting these actions the service provides an entry point with the ability to understand the availability of relevant information, and provides the source data to display a summary and link where needed. Without a summary API the entry point service may need to use many API calls to gather the information needed

Implementation

The Refer and Monitor an Intervention API service provides a summary API to support probation entry point services accessing high-level CRS intervention data. Manage People on Probation calls the API when surfacing information on active and completed interventions, and provides links to the Refer and Monitor an Intervention service for detailed session information