API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/access/{identifier}

get

Provides the case access for a given user and case identifier (crn or prisoner number)

Parameters

Parameter	In	Type	Required	Description
username	path	string	true
identifier	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string", "userExcluded": "boolean", "userRestricted": "boolean", "exclusionMessage": "string", "restrictionMessage": "string" }`	CaseAccess

{
  "crn": "string",
  "userExcluded": "boolean",
  "userRestricted": "boolean",
  "exclusionMessage": "string",
  "restrictionMessage": "string"
}

CaseAccess

/providers

get

Returns a list of providers

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/providers/{providerCode}/pdus

get

Returns a list of pdus for a given provider code

Parameters

Parameter	In	Type	Required	Description
providerCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/providers/{providerCode}/pdus/{pduCode}/locations

get

Returns a list of office locations for a given provider code and pdu code

Parameters

Parameter	In	Type	Required	Description
providerCode	path	string	true
pduCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/person/{crn}/accredited-programme-history

get

Returns a list of accredited programmes for the provided crn

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/person/find/{identifier}

get

Finds an offender with the provided identifier (crn or prisoner number)

Parameters

Parameter	In	Type	Required	Description
identifier	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string", "nomsNumber": "string", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "dateOfBirth": "string", "ethnicity": "string", "gender": "string", "probationDeliveryUnit": { "code": "string", "description": "string" }, "setting": "string" }`	PersonResponse

{
  "crn": "string",
  "nomsNumber": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "ethnicity": "string",
  "gender": "string",
  "probationDeliveryUnit": {
    "code": "string",
    "description": "string"
  },
  "setting": "string"
}

PersonResponse

Schemas

CaseAccess

Name	Type	Required
crn	string	true
userExcluded	boolean	true
userRestricted	boolean	true
exclusionMessage	string	false
restrictionMessage	string	false

Provider

Name	Type	Required	Description	Schema
code	string	false
description	string	true

ProbationDeliveryUnit

Name	Type	Required	Description	Schema
code	string	false
description	string	true

OfficeAddress

Name	Type	Required
officeName	string	true
buildingName	string	false
buildingNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
email	string	false
ldu	string	true
telephoneNumber	string	false
from	string	true
to	string	false

AccreditedProgramme

Name	Type	Required
programme	string	false
startDate	string	true
endDate	string	false
endReason	string	false
description	string	false
active	boolean	true
notes	string	false

Name

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

PersonResponse

Name	Type	Required	Schema
crn	string	true
nomsNumber	string	false
name	object	true	Name
dateOfBirth	string	true
ethnicity	string	false
gender	string	false
probationDeliveryUnit	object	false	ProbationDeliveryUnit
setting	string	true