API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/roles/{roleName}

put

Parameters

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

Responses

Status	Description	Schema
200	OK

delete

Parameters

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

Responses

Status	Description	Schema
200	OK

/search/probation-cases

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/search/probation-cases/crns

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/court-appearances

post

Get all court appearances from today onwards, for a list of up to 500 CRNs

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "courtAppearances": { } }`	AllCourtAppearancesContainer

{
  "courtAppearances": {
  }
}

AllCourtAppearancesContainer

/users/{username}/details

get

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "username": "string", "forename": "string", "surname": "string", "email": "string" }`	UserDetails

{
  "username": "string",
  "forename": "string",
  "surname": "string",
  "email": "string"
}

UserDetails

/probation-areas

get

Parameters

Parameter	In	Type	Required	Description
includeNonSelectable	query	boolean	false	Include (true) or exclude (false) any probation areas that are not selectable

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "probationAreas": [ { "code": "string", "description": "string", "localDeliveryUnits": [ { "code": "string", "description": "string" } ] } ] }`	ProbationAreaContainer

{
  "probationAreas": [
    {
      "code": "string",
      "description": "string",
      "localDeliveryUnits": [
        {
          "code": "string",
          "description": "string"
        }
      ]
    }
  ]
}

ProbationAreaContainer

/detail/{value}

get

Parameters

Parameter	In	Type	Required	Description
value	path	string	true
type	query	string	false	Available items: CRN NOMS

Parameter

Type

Required

Description

value

path

string

true

type

query

string

false

Available items:

CRN
NOMS

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "dateOfBirth": "string", "crn": "string", "nomisId": "string", "pncNumber": "string", "offenderManager": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "team": { "code": "string", "localDeliveryUnit": { "code": "string", "name": "string" } }, "provider": { "code": "string", "description": "string" } }, "activeProbationManagedSentence": "boolean", "currentlyInPrison": "boolean", "mainOffence": "string", "profile": { "nationality": "string", "religion": "string" }, "keyDates": [ { "code": "string", "description": "string", "data": "string" } ], "releaseDate": "string", "releaseReason": "string", "releaseLocation": "string", "lastRecallDate": "string", "recallReason": "string", "nsiRecallDate": "string", "nsiBreachDate": "string", "offenderAliases": [ { "id": "integer", "dateOfBirth": "string", "firstName": "string", "middleNames": [ { } ], "surname": "string", "gender": "string" } ] }	Detail

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "crn": "string",
  "nomisId": "string",
  "pncNumber": "string",
  "offenderManager": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "team": {
      "code": "string",
      "localDeliveryUnit": {
        "code": "string",
        "name": "string"
      }
    },
    "provider": {
      "code": "string",
      "description": "string"
    }
  },
  "activeProbationManagedSentence": "boolean",
  "currentlyInPrison": "boolean",
  "mainOffence": "string",
  "profile": {
    "nationality": "string",
    "religion": "string"
  },
  "keyDates": [
    {
      "code": "string",
      "description": "string",
      "data": "string"
    }
  ],
  "releaseDate": "string",
  "releaseReason": "string",
  "releaseLocation": "string",
  "lastRecallDate": "string",
  "recallReason": "string",
  "nsiRecallDate": "string",
  "nsiBreachDate": "string",
  "offenderAliases": [
    {
      "id": "integer",
      "dateOfBirth": "string",
      "firstName": "string",
      "middleNames": [
        {
        }
      ],
      "surname": "string",
      "gender": "string"
    }
  ]
}

Detail

/court-appearances/{value}

get

Parameters

Parameter	In	Type	Required	Description
value	path	string	true
type	query	string	false	Available items: CRN NOMS
fromDate	query	string	false

Parameter

Type

Required

Description

value

path

string

true

type

query

string

false

Available items:

CRN
NOMS

fromDate

query

string

false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "courtAppearances": [ { "appearanceDate": "string", "type": { "code": "string", "description": "string" }, "courtCode": "string", "courtName": "string", "crn": "string", "courtAppearanceId": "integer", "offenderId": "integer" } ] }`	CourtAppearancesContainer

{
  "courtAppearances": [
    {
      "appearanceDate": "string",
      "type": {
        "code": "string",
        "description": "string"
      },
      "courtCode": "string",
      "courtName": "string",
      "crn": "string",
      "courtAppearanceId": "integer",
      "offenderId": "integer"
    }
  ]
}

CourtAppearancesContainer

/convictions/{value}

get

Parameters

Parameter	In	Type	Required	Description
value	path	string	true
type	query	string	false	Available items: CRN NOMS
activeOnly	query	boolean	false

Parameter

Type

Required

Description

value

path

string

true

type

query

string

false

Available items:

CRN
NOMS

activeOnly

query

boolean

false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "convictions": [ { "convictionId": "integer", "convictionDate": "string", "referralDate": "string", "outcome": "string", "latestCourtAppearanceOutcome": "string", "offences": [ { "offenceId": "integer", "description": "string", "mainCategoryDescription": "string", "mainOffence": "boolean" } ], "sentence": { "sentenceId": "integer", "startDate": "string", "expectedEndDate": "string", "custody": { "bookingNumber": "string", "status": { "code": "string", "description": "string" }, "keyDates": [ { "code": "string", "description": "string", "data": "string" } ] } }, "active": "boolean" } ] }	ConvictionsContainer

{
  "convictions": [
    {
      "convictionId": "integer",
      "convictionDate": "string",
      "referralDate": "string",
      "outcome": "string",
      "latestCourtAppearanceOutcome": "string",
      "offences": [
        {
          "offenceId": "integer",
          "description": "string",
          "mainCategoryDescription": "string",
          "mainOffence": "boolean"
        }
      ],
      "sentence": {
        "sentenceId": "integer",
        "startDate": "string",
        "expectedEndDate": "string",
        "custody": {
          "bookingNumber": "string",
          "status": {
            "code": "string",
            "description": "string"
          },
          "keyDates": [
            {
              "code": "string",
              "description": "string",
              "data": "string"
            }
          ]
        }
      },
      "active": "boolean"
    }
  ]
}

ConvictionsContainer

Schemas

SearchRequest

Name	Type	Required
firstName	string	false
surname	string	false
dateOfBirth	string	false
pncNumber	string	false
crn	string	false
nomsNumber	string	false

IDs

Name	Type	Required
crn	string	true
nomsNumber	string	false
pncNumber	string	false

KeyValue

Name	Type	Required	Description	Schema
code	string	false
description	string	false

LocalDeliveryUnit

Name	Type	Required	Description	Schema
code	string	true
description	string	true

OffenderAlias

Name	Type	Required
id	integer	true
dateOfBirth	string	false
firstName	string	true
middleNames	array	true
surname	string	true
gender	string	true

OffenderDetail

Name	Type	Required	Schema
firstName	string	false
middleNames	array	false
surname	string	false
dateOfBirth	string	false
gender	string	false
otherIds	object	true	IDs
offenderProfile	object	false	OffenderProfile
offenderAliases	array	false	OffenderAlias
offenderManagers	array	false	OffenderManager

OffenderManager

Name	Type	Required	Schema
staff	object	false	StaffHuman
team	object	false	SearchResponseTeam
probationArea	object	false	ProbationArea
active	boolean	false

OffenderProfile

Name	Type	Required
ethnicity	string	false
nationality	string	false
religion	string	false

ProbationArea

Name	Type	Required	Schema
code	string	true
description	string	true
localDeliveryUnits	array	true	LocalDeliveryUnit

SearchResponseTeam

Name	Type	Required	Schema
code	string	false
description	string	false
localDeliveryUnit	object	false	KeyValue

StaffHuman

Name	Type	Required
code	string	false
forenames	string	false
surname	string	false
unallocated	boolean	false

AllCourtAppearancesContainer

Name	Type	Required	Description	Schema
courtAppearances	object	true

CourtAppearance

Name	Type	Required	Schema
appearanceDate	string	true
type	object	true	Type
courtCode	string	true
courtName	string	true
crn	string	true
courtAppearanceId	integer	true
offenderId	integer	true

Type

Name	Type	Required	Description	Schema
code	string	true
description	string	true

UserDetails

Name	Type	Required
username	string	true
forename	string	true
surname	string	true
email	string	false

ProbationAreaContainer

Name	Type	Required	Description	Schema
probationAreas	array	true		ProbationArea

Detail

Name	Type	Required	Schema
name	object	true	Name
dateOfBirth	string	true
crn	string	true
nomisId	string	false
pncNumber	string	false
offenderManager	object	true	Manager
activeProbationManagedSentence	boolean	true
currentlyInPrison	boolean	true
mainOffence	string	false
profile	object	false	Profile
keyDates	array	true	KeyDate
releaseDate	string	false
releaseReason	string	false
releaseLocation	string	false
lastRecallDate	string	false
recallReason	string	false
nsiRecallDate	string	false
nsiBreachDate	string	false
offenderAliases	array	true	OffenderAlias

KeyDate

Name	Type	Required
code	string	true
description	string	true
data	string	true

Ldu

Name	Type	Required	Description	Schema
code	string	true
name	string	true

Manager

Name	Type	Required	Schema
name	object	true	Name
team	object	true	Team
provider	object	true	Provider

Name

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

Profile

Name	Type	Required	Description	Schema
nationality	string	false
religion	string	false

Provider

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Team

Name	Type	Required	Description	Schema
code	string	true
localDeliveryUnit	object	true		Ldu

CourtAppearancesContainer

Name	Type	Required	Description	Schema
courtAppearances	array	true		CourtAppearance

Conviction

Name	Type	Required	Schema
convictionId	integer	true
convictionDate	string	false
referralDate	string	true
outcome	string	true
latestCourtAppearanceOutcome	string	true
offences	array	true	Offence
sentence	object	false	Sentence
active	boolean	true

ConvictionsContainer

Name	Type	Required	Description	Schema
convictions	array	true		Conviction

Custody

Name	Type	Required	Schema
bookingNumber	string	false
status	object	true	CustodyStatus
keyDates	array	true	KeyDate

CustodyStatus

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Offence

Name	Type	Required
offenceId	integer	true
description	string	true
mainCategoryDescription	string	false
mainOffence	boolean	true

Sentence

Name	Type	Required	Schema
sentenceId	integer	true
startDate	string	true
expectedEndDate	string	false
custody	object	false	Custody