API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/probation-case/{prisonerId}/main-address

get

Get the current main address for a probation case

Accepts the prisoner identifier (NOMS number) and returns the current main address linked to the probation case.

Requires PROBATION_API__PRISON_EDUCATION__CASE_DETAIL.

Parameters

Parameter	In	Type	Required	Description
prisonerId	path	string	true

Responses

Status	Description	Schema
200	OK { "buildingName": "string", "addressNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "noFixedAbode": "boolean" }	AddressResponse

/probation-case/{prisonerId}/community-manager

get

Get the current active community manager for a probation case

Accepts the prisoner identifier (NOMS number) and returns the currently active community manager of the probation case.

Requires PROBATION_API__PRISON_EDUCATION__CASE_DETAIL.

Parameters

Parameter	In	Type	Required	Description
prisonerId	path	string	true

Responses

Status	Description	Schema
200	OK { "firstName": "string", "lastName": "string", "email": "string" }	CommunityManagerResponse

Schemas

AddressResponse

Name	Type	Required	Description	Schema
buildingName	string	false
addressNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
noFixedAbode	boolean	false

CommunityManagerResponse

Name	Type	Required	Description	Schema
firstName	string	true
lastName	string	true
email	string	false