API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/probation-cases/{identifier}

get

Parameters

Parameter	In	Type	Required	Description
identifier	path	string	true

Responses

Status	Description	Schema
200	OK { "identifiers": { "deliusId": "integer", "crn": "string", "nomsId": "string", "prisonerNumber": "string", "pnc": "string", "cro": "string", "ni": "string" }, "name": { "forename": "string", "middleName": "string", "surname": "string", "previousSurname": "string", "preferred": "string" }, "dateOfBirth": "string", "title": { "code": "string", "description": "string" }, "gender": { "code": "string", "description": "string" }, "nationality": { "code": "string", "description": "string" }, "ethnicity": { "code": "string", "description": "string" }, "ethnicityDescription": "string", "contactDetails": { "telephone": "string", "mobile": "string", "email": "string" }, "aliases": [ { "name": { "forename": "string", "middleName": "string", "surname": "string", "previousSurname": "string", "preferred": "string" }, "dateOfBirth": "string" } ], "addresses": [ { "fullAddress": "string", "postcode": "string", "noFixedAbode": "boolean", "status": { "code": "string", "description": "string" }, "startDate": "string", "endDate": "string" } ], "excludedFrom": { "message": "string", "users": [ { "username": "string" } ] }, "restrictedTo": { "message": "string", "users": [ { "username": "string" } ] }, "sentences": [ { "date": "string", "active": "boolean" } ] }	PersonDetail

/all-probation-cases

get

Parameters

Parameter	In	Type	Required	Description
pageable	query	object	true

Responses

Status	Description	Schema
200	OK { "content": [ { "identifiers": { "deliusId": "integer", "crn": "string", "nomsId": "string", "prisonerNumber": "string", "pnc": "string", "cro": "string", "ni": "string" }, "name": { "forename": "string", "middleName": "string", "surname": "string", "previousSurname": "string", "preferred": "string" }, "dateOfBirth": "string", "title": { "code": "string", "description": "string" }, "gender": { "code": "string", "description": "string" }, "nationality": { "code": "string", "description": "string" }, "ethnicity": { "code": "string", "description": "string" }, "ethnicityDescription": "string", "contactDetails": { "telephone": "string", "mobile": "string", "email": "string" }, "aliases": [ { "name": { "forename": "string", "middleName": "string", "surname": "string", "previousSurname": "string", "preferred": "string" }, "dateOfBirth": "string" } ], "addresses": [ { "fullAddress": "string", "postcode": "string", "noFixedAbode": "boolean", "status": { "code": "string", "description": "string" }, "startDate": "string", "endDate": "string" } ], "excludedFrom": { "message": "string", "users": [ { "username": "string" } ] }, "restrictedTo": { "message": "string", "users": [ { "username": "string" } ] }, "sentences": [ { "date": "string", "active": "boolean" } ] } ], "page": { "size": "integer", "number": "integer", "totalElements": "integer", "totalPages": "integer" } }	PagedModelPersonDetail

Schemas

Address

Name	Type	Required	Description	Schema
fullAddress	string	true
postcode	string	true
noFixedAbode	boolean	true
status	object	true		CodeDescription
startDate	string	true
endDate	string	false

Alias

Name	Type	Required	Description	Schema
name	object	true		Name
dateOfBirth	string	true

CodeDescription

Name	Type	Required	Description	Schema
code	string	true
description	string	true

ContactDetails

Name	Type	Required	Description	Schema
telephone	string	false
mobile	string	false
email	string	false

Identifiers

Name	Type	Required	Description	Schema
deliusId	integer	true
crn	string	true
nomsId	string	false
prisonerNumber	string	false
pnc	string	false
cro	string	false
ni	string	false

LimitedAccess

Name	Type	Required	Description	Schema
message	string	false
users	array	true		LimitedAccessUser

LimitedAccessUser

Name	Type	Required	Description	Schema
username	string	true

Name

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

PersonDetail

Name	Type	Required	Description	Schema
identifiers	object	true		Identifiers
name	object	true		Name
dateOfBirth	string	true
title	object	false		CodeDescription
gender	object	false		CodeDescription
nationality	object	false		CodeDescription
ethnicity	object	false		CodeDescription
ethnicityDescription	string	false
contactDetails	object	false		ContactDetails
aliases	array	true		Alias
addresses	array	true		Address
excludedFrom	object	false		LimitedAccess
restrictedTo	object	false		LimitedAccess
sentences	array	true		Sentence

Sentence

Name	Type	Required	Description	Schema
date	string	true
active	boolean	true

Pageable

Name	Type	Required	Description	Schema
page	integer	false
size	integer	false
sort	array	false

PageMetadata

Name	Type	Required	Description	Schema
size	integer	false
number	integer	false
totalElements	integer	false
totalPages	integer	false

PagedModelPersonDetail

Name	Type	Required	Description	Schema
content	array	false		PersonDetail
page	object	false		PageMetadata