API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/docs/asyncapi

get

Responses

Status	Description	Schema
200	OK { }

/case-records/{identifier}

get

Background information on the probation case

Background details of the probation case for the purposes of allocating a new Prison Offender Manager. The service will return case information for either the CRN or NOMS number supplied in the request.

        <p>Requires `PROBATION_API__MANAGE_POM_CASES__CASE_DETAIL`.</p>

Parameters

Parameter	In	Type	Required	Description
identifier	path	string	true

Responses

Status	Description	Schema
200	OK { "crn": "string", "nomsId": "string", "currentTier": "string", "resourcing": "string", "manager": { "team": { "code": "string", "description": "string", "localDeliveryUnit": { "code": "string", "description": "string" } }, "code": "string", "name": { "forename": "string", "surname": "string" }, "email": "string" }, "mappaLevel": "integer", "vloAssigned": "boolean" }	ProbationRecord
404	No probation case found with the given identifier. For a prison identifier this could mean the Prison and Probation cases have not been linked yet. { "status": "integer", "message": "string", "fields": [ { "type": "string", "message": "string", "field": "string" } ] }	ErrorResponse

/case-records/{crn}/risks/mappa

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status	Description	Schema
200	OK { "level": 1, "levelDescription": "MAPPA Level 1", "category": 3, "categoryDescription": "MAPPA Cat 1", "startDate": "2021-01-27", "reviewDate": "2021-04-27" }	MappaDetail

Schemas

ErrorResponse

Name	Type	Required	Description	Schema
status	integer	true
message	string	false
fields	array	false		FieldError

FieldError

Name	Type	Required	Description	Schema
type	string	false
message	string	false
field	string	false

LocalDeliveryUnit

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Manager

Name	Type	Required	Description	Schema
team	object	true		Team
code	string	false
name	object	false		Name
email	string	false

Name

Name	Type	Required	Description	Schema
forename	string	true
surname	string	true

ProbationRecord

Name	Type	Required	Description	Schema
crn	string	true
nomsId	string	false
currentTier	string	false
resourcing	string	false
manager	object	true		Manager
mappaLevel	integer	true
vloAssigned	boolean	true

Team

Name	Type	Required	Description	Schema
code	string	true
description	string	true
localDeliveryUnit	object	false		LocalDeliveryUnit

MappaDetail

Name	Type	Required	Description	Schema
level	integer	false	MAPPA Level (0=unknown). If the level is unknown due to an unrecognised Delius MAPPA level code (e.g. one not used anymore) the original Delius level description will still be returned
levelDescription	string	false	MAPPA Level Description
category	integer	false	MAPPA Category (0 = unknown). If the category is unknown due to an unrecognised Delius MAPPA category code (e.g. one not used anymore) the original Delius category description will still be returned
categoryDescription	string	false	MAPPA Category Description
startDate	string	true	Start date
reviewDate	string	false	Next review date