Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/user/{username}

get

User details

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "username": "string",
  "email": "string",
  "homeArea": {
    "code": "string",
    "name": "string"
  },
  "staffCode": "string"
}
 UserDetails

/user/{username}/access/{crn}

get

Details of any restrictions or exclusions

Returns either an exclusionMessage or restrictionMessage if the user is not allowed to access the case.

This can happen if the user is excluded from viewing the case (e.g. a family member), or if the case has been restricted to a subset of users that the user is not a part of (e.g. high profile cases).

Parameters

ParameterInTypeRequiredDescription
username path string true
crn path string true

Responses

StatusDescriptionSchema
404

A case with the provided CRN does not exist in Delius. Note: this could be the result of a merge or a deletion.

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

/provider

get

List active providers

Responses

StatusDescriptionSchema
200

OK

{
}

/provider/{code}

get

Provider details by code

Parameters

ParameterInTypeRequiredDescription
code path string true

Responses

StatusDescriptionSchema
200

OK

{
  "code": "string",
  "name": "string"
}
 Provider

/document/{crn}/{id}

get

Download document content

Parameters

ParameterInTypeRequiredDescription
crn path string true
id path string true

Responses

StatusDescriptionSchema
200

OK

{
}
 StreamingResponseBody

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

/case-summary/{crn}/recommendation-model

get

Case data required to populate the recommendation model

This is used to populate the Recall Part A document template when a recommendation is made, and to refresh the case data when a recall decision is made later.

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "mainAddress": {
    "buildingName": "string",
    "addressNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "noFixedAbode": "boolean"
  },
  "lastRelease": {
    "releaseDate": "string",
    "recallDate": "string"
  },
  "lastReleasedFromInstitution": {
    "name": "string",
    "description": "string"
  },
  "mappa": {
    "category": "integer",
    "level": "integer",
    "startDate": "string"
  },
  "activeConvictions": [
    {
      "number": "string",
      "sentence": {
        "description": "string",
        "length": "integer",
        "lengthUnits": "string",
        "isCustodial": "boolean",
        "custodialStatusCode": "string",
        "licenceExpiryDate": "string",
        "sentenceExpiryDate": "string"
      },
      "mainOffence": {
        "date": "string",
        "code": "string",
        "description": "string"
      },
      "additionalOffences": [
        {
          "date": "string",
          "code": "string",
          "description": "string"
        }
      ]
    }
  ],
  "activeCustodialConvictions": [
    {
      "number": "string",
      "sentence": {
        "description": "string",
        "length": "integer",
        "lengthUnits": "string",
        "secondLength": "integer",
        "secondLengthUnits": "string",
        "isCustodial": "boolean",
        "custodialStatusCode": "string",
        "startDate": "string",
        "licenceExpiryDate": "string",
        "sentenceExpiryDate": "string"
      },
      "mainOffence": {
        "date": "string",
        "code": "string",
        "description": "string"
      },
      "additionalOffences": [
        {
          "date": "string",
          "code": "string",
          "description": "string"
        }
      ]
    }
  ]
}
 RecommendationModel

/case-summary/{crn}/personal-details

get

Personal details including name, date of birth, address

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "mainAddress": {
    "buildingName": "string",
    "addressNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "noFixedAbode": "boolean"
  },
  "communityManager": {
    "staffCode": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "provider": {
      "code": "string",
      "name": "string"
    },
    "team": {
      "code": "string",
      "name": "string",
      "localAdminUnit": "string",
      "telephone": "string",
      "email": "string"
    }
  }
}
 PersonalDetails

/case-summary/{crn}/overview

get

Overview of the probation case including active events/convictions, register flags

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "registerFlags": [
    {
    }
  ],
  "lastRelease": {
    "releaseDate": "string",
    "recallDate": "string"
  },
  "activeConvictions": [
    {
      "number": "string",
      "sentence": {
        "description": "string",
        "length": "integer",
        "lengthUnits": "string",
        "isCustodial": "boolean",
        "custodialStatusCode": "string",
        "licenceExpiryDate": "string",
        "sentenceExpiryDate": "string"
      },
      "mainOffence": {
        "date": "string",
        "code": "string",
        "description": "string"
      },
      "additionalOffences": [
        {
          "date": "string",
          "code": "string",
          "description": "string"
        }
      ]
    }
  ]
}
 Overview

/case-summary/{crn}/mappa-and-rosh-history

get

Current MAPPA and historical RoSH registrations

This is intended to populate the MAPPA (Multi-agency public protection arrangements) and RoSH (Risk of Serious Harm) widgets.

Note that risk assessment information is generally held in OASys, and this endpoint only surfaces supplementary Delius registration/register details.

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "mappa": {
    "category": "integer",
    "level": "integer",
    "startDate": "string"
  },
  "roshHistory": [
    {
      "active": "boolean",
      "type": "string",
      "typeDescription": "string",
      "notes": "string",
      "startDate": "string"
    }
  ]
}
 MappaAndRoshHistory

/case-summary/{crn}/licence-conditions

get

Active events/convictions, with licence conditions

Only returns active licence conditions that are associated with active events/convictions

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "activeConvictions": [
    {
      "number": "string",
      "sentence": {
        "description": "string",
        "length": "integer",
        "lengthUnits": "string",
        "isCustodial": "boolean",
        "custodialStatusCode": "string",
        "licenceExpiryDate": "string",
        "sentenceExpiryDate": "string"
      },
      "mainOffence": {
        "date": "string",
        "code": "string",
        "description": "string"
      },
      "additionalOffences": [
        {
          "date": "string",
          "code": "string",
          "description": "string"
        }
      ],
      "licenceConditions": [
        {
          "startDate": "string",
          "mainCategory": {
            "code": "string",
            "description": "string"
          },
          "subCategory": {
            "code": "string",
            "description": "string"
          },
          "notes": "string"
        }
      ]
    }
  ]
}
 LicenceConditions

/case-summary/{crn}/contact-history

get

Contact history

Returns matching historical records from the Delius contact log, including linked documents, and a summary showing the total number of contacts on the case grouped by type.

Parameters

ParameterInTypeRequiredDescription
crn path string true
query query string false

Search for contacts that contain the provided text. This currently performs a simple substring match against the notes.
from query string false

Return only contacts that start after this date
to query string false

Return only contacts that start before this date. Defaults to the current date. If provided, this value must be on or before the current date.
type query array false

Filter on contact type codes
includeSystemGenerated query boolean false

Include (true) or exclude (false) any contact types that are system-generated

Responses

StatusDescriptionSchema
200

OK

{
  "personalDetails": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "identifiers": {
      "pncNumber": "string",
      "croNumber": "string",
      "nomsNumber": "string",
      "bookingNumber": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "ethnicity": "string",
    "primaryLanguage": "string"
  },
  "contacts": [
    {
      "description": "string",
      "documents": [
        {
          "id": "string",
          "name": "string",
          "lastUpdated": "string"
        }
      ],
      "enforcementAction": "string",
      "notes": "string",
      "outcome": "string",
      "sensitive": "boolean",
      "startDateTime": "string",
      "type": {
        "code": "string",
        "description": "string",
        "systemGenerated": "boolean"
      }
    }
  ],
  "summary": {
    "types": [
      {
        "code": "string",
        "description": "string",
        "total": "integer"
      }
    ],
    "hits": "integer",
    "total": "integer"
  }
}
 ContactHistory

/ap-residence-plan-document/{crn}

get

Find latest approved premises residence plan document

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "string",
  "author": "string",
  "createdAt": "string",
  "lastUpdatedAt": "string"
}
 Document

Schemas

Name

NameTypeRequiredDescriptionSchema
forename string true
middleName string false
surname string true

Provider

NameTypeRequiredDescriptionSchema
code string true
name string true

UserDetails

NameTypeRequiredDescriptionSchema
name object true Name
username string true
email string false
homeArea object false Provider
staffCode string false

UserAccess

NameTypeRequiredDescriptionSchema
exclusionMessage string false
restrictionMessage string false
userExcluded boolean true
userRestricted boolean true

StreamingResponseBody

Address

NameTypeRequiredDescriptionSchema
buildingName string false
addressNumber string false
streetName string false
district string false
town string false
county string false
postcode string false
noFixedAbode boolean false

Conviction

NameTypeRequiredDescriptionSchema
number string true
sentence object false Sentence
mainOffence object true Offence
additionalOffences array true Offence

ConvictionDetails

NameTypeRequiredDescriptionSchema
number string true
sentence object false ExtendedSentence
mainOffence object true Offence
additionalOffences array true Offence

ExtendedSentence

NameTypeRequiredDescriptionSchema
description string true
length integer false
lengthUnits string false
secondLength integer false
secondLengthUnits string false
isCustodial boolean true
custodialStatusCode string false
startDate string false
licenceExpiryDate string false
sentenceExpiryDate string false

Identifiers

NameTypeRequiredDescriptionSchema
pncNumber string false
croNumber string false
nomsNumber string false
bookingNumber string false

Institution

NameTypeRequiredDescriptionSchema
name string false
description string true

Mappa

NameTypeRequiredDescriptionSchema
category integer false
level integer false
startDate string true

Offence

NameTypeRequiredDescriptionSchema
date string false
code string true
description string true

PersonalDetailsOverview

NameTypeRequiredDescriptionSchema
name object true Name
identifiers object true Identifiers
dateOfBirth string true
gender string true
ethnicity string false
primaryLanguage string false

RecommendationModel

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
mainAddress object false Address
lastRelease object false Release
lastReleasedFromInstitution object false Institution
mappa object false Mappa
activeConvictions array true Conviction
activeCustodialConvictions array true ConvictionDetails

Release

NameTypeRequiredDescriptionSchema
releaseDate string true
recallDate string false

Sentence

NameTypeRequiredDescriptionSchema
description string true
length integer false
lengthUnits string false
isCustodial boolean true
custodialStatusCode string false
licenceExpiryDate string false
sentenceExpiryDate string false

Manager

NameTypeRequiredDescriptionSchema
staffCode string true
name object true Name
provider object true Provider
team object true Team

PersonalDetails

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
mainAddress object false Address
communityManager object false Manager

Team

NameTypeRequiredDescriptionSchema
code string true
name string true
localAdminUnit string true
telephone string false
email string false

Overview

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
registerFlags array true
lastRelease object false Release
activeConvictions array true Conviction

MappaAndRoshHistory

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
mappa object false Mappa
roshHistory array true Rosh

Rosh

NameTypeRequiredDescriptionSchema
active boolean true
type string true
typeDescription string true
notes string false
startDate string true

ConvictionWithLicenceConditions

NameTypeRequiredDescriptionSchema
number string true
sentence object false Sentence
mainOffence object true Offence
additionalOffences array true Offence
licenceConditions array true LicenceCondition

LicenceCondition

NameTypeRequiredDescriptionSchema
startDate string true
mainCategory object true LicenceConditionCategory
subCategory object false LicenceConditionCategory
notes string false

LicenceConditionCategory

NameTypeRequiredDescriptionSchema
code string true
description string true

LicenceConditions

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
activeConvictions array true ConvictionWithLicenceConditions

Contact

NameTypeRequiredDescriptionSchema
description string false
documents array true DocumentReference
enforcementAction string false
notes string false
outcome string false
sensitive boolean false
startDateTime string true
type object true Type

ContactHistory

NameTypeRequiredDescriptionSchema
personalDetails object true PersonalDetailsOverview
contacts array true Contact
summary object true ContactSummary

ContactSummary

NameTypeRequiredDescriptionSchema
types array true ContactTypeSummary
hits integer true
total integer true

ContactTypeSummary

NameTypeRequiredDescriptionSchema
code string true
description string true
total integer true

DocumentReference

NameTypeRequiredDescriptionSchema
id string true
name string true
lastUpdated string true

Type

NameTypeRequiredDescriptionSchema
code string true
description string true
systemGenerated boolean true

Document

NameTypeRequiredDescriptionSchema
id string true
name string true
description string false
type string true
author string false
createdAt string false
lastUpdatedAt string false