API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/document/{id}

get

Download document content

Parameters

Parameter	In	Type	Required	Description
id	path	string	true

Responses

Status	Description	Schema
200	OK { }	StreamingResponseBody

/case/{nomisId}/documents

get

List documents for a case

Returns basic personal information for the case, along with a list of person-level documents and event-level documents. Documents are annotated with the type and description, based on what they relate to in the probation case (e.g. a court appearance, an event, etc).

Parameters

Parameter	In	Type	Required	Description
nomisId	path	string	true

Responses

Status	Description	Schema
200	OK { "crn": "string", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "documents": [ { "id": "string", "name": "string", "description": "string", "type": "string", "author": "string", "createdAt": "string" } ], "convictions": [ { "title": "string", "offence": "string", "date": "string", "active": "boolean", "documents": [ { "id": "string", "name": "string", "description": "string", "type": "string", "author": "string", "createdAt": "string" } ], "institutionName": "string" } ] }	ProbationDocumentsResponse

Schemas

StreamingResponseBody

Conviction

Name	Type	Required	Description	Schema
title	string	false
offence	string	true
date	string	true
active	boolean	true
documents	array	true		Document
institutionName	string	false

Document

Name	Type	Required	Description	Schema
id	string	true
name	string	true
description	string	false
type	string	true
author	string	false
createdAt	string	false

Name

Name	Type	Required	Description	Schema
forename	string	true
middleName	string	false
surname	string	true

ProbationDocumentsResponse

Name	Type	Required	Description	Schema
crn	string	true
name	object	true		Name
documents	array	true		Document
convictions	array	true		Conviction