List reports

Description

This endpoint returns a list of unread adverse incident reports. It has two optional query parameters, reportArea and fromDate, which control what is included in the response.

Endpoint path

[GET] /api/v2/delivery/list

Query parameters

The endpoint has two optional query parameters

• reportArea
  If specified, the response will contain only reports for the specified report area. Most of the clients will support one report area only, and in those cases this parameter has no effect. However, if the report area specified does not match the client's supported report area, a 400 bad request is returned.
• fromDate
  The response will by default contain unread reports only. If the fromDate parameter is specified, all reports from that date and to the current time are returned. The parameter value must have the ISO date format (yyyy-mm-dd).

Required scopes

To be able call this endpoint, the HelseId client must have one of the following scopes:

• nhn:melde/delivery/restricted-access
• nhn:melde/delivery/full-access

Response

The endpoint returns a list of references to adverse incident reports. Each list element has this format:

{
  "ReportRef": "",        // Report reference
  "ReportArea": nnn,      // Report area id
  "IsRead": true/false    // true or false
}

See Swagger UI for more information