Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/limited-access

get

Data access restriction information for the combination of the Delius user and the supplied list of CRNs

Probation case records in Delius may have access restrictions defined for particular Delius users. This restrictions may be in place to stop identified users accessing information on specific people or they may restrict access to all users other than those named. The restrictions may be in place for a number of reasons related to the case supervision and clients should use the restriction information to mask data access from any identified user that has a restriction in place

Parameters

ParameterInTypeRequiredDescription
crns query array true
username query string false

Responses

StatusDescriptionSchema
200

OK

{
  "access": [
    {
      "crn": "string",
      "userExcluded": "boolean",
      "userRestricted": "boolean",
      "exclusionMessage": "string",
      "restrictionMessage": "string"
    }
  ]
}
 UserAccess

post

Data access restriction information for the combination of the Delius user and the supplied list of CRNs

Probation case records in Delius may have access restrictions defined for particular Delius users. This restrictions may be in place to stop identified users accessing information on specific people or they may restrict access to all users other than those named. The restrictions may be in place for a number of reasons related to the case supervision and clients should use the restriction information to mask data access from any identified user that has a restriction in place

Parameters

ParameterInTypeRequiredDescription
username query string false

Responses

StatusDescriptionSchema
200

OK

{
  "access": [
    {
      "crn": "string",
      "userExcluded": "boolean",
      "userRestricted": "boolean",
      "exclusionMessage": "string",
      "restrictionMessage": "string"
    }
  ]
}
 UserAccess

/staff/{code}/active-cases

post

Personal information along with a list of active cases for the identified probation practitioner

Summary information on the full case list of of the probation practitioner identified in the request. Used to support the ‘Case Details’ capability of the HMPPS Workload service, which show details of the current case load of the staff member for capacity planning

Parameters

ParameterInTypeRequiredDescription
code path string true

Responses

StatusDescriptionSchema
200

OK

{
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "grade": "string",
  "email": "string",
  "cases": [
    {
      "crn": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "type": "string"
    }
  ]
}
 ActiveCasesResponse

/allocation/details

post

Summary information on the person on probation and probation practitioner

Summary information on the person on probation and probation practitioner identified by the list of CRNs and staff codes provided in the request. Used to support showing the impact of case allocations in the HMPPS Workforce service

Responses

StatusDescriptionSchema
200

OK

{
  "cases": [
    {
      "crn": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "staff": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "email": "string",
        "grade": "string"
      }
    }
  ]
}
 AllocationDetails

/allocation-demand

post

List of summary probation case details for cases that require allocation

Summary information on the probation case list provided in the request. Used to support the list of ‘Unallocated Community Cases’ in the HMPPS Workforce service which shows the list of cases that require allocation to a probation practitioner

Responses

StatusDescriptionSchema
200

OK

{
  "cases": [
    {
      "crn": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "event": {
        "number": "string",
        "manager": {
          "code": "string",
          "name": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          },
          "teamCode": "string",
          "grade": "string",
          "allocated": "boolean"
        }
      },
      "sentence": {
        "type": "string",
        "date": "string",
        "length": "string"
      },
      "initialAppointment": {
        "date": "string",
        "staff": {
          "code": "string",
          "name": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          },
          "email": "string",
          "grade": "string"
        }
      },
      "court": {
        "name": "string"
      },
      "type": "string",
      "probationStatus": {
        "status": "string",
        "description": "string"
      },
      "communityPersonManager": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "teamCode": "string",
        "grade": "string",
        "allocated": "boolean"
      },
      "handoverDate": "string"
    }
  ]
}
 AllocationDemandResponse

/staff/{code}/officer-view

get

Personal and and summary caseload information for the identified probation officer

Summary information on the probation caseload for the probation officer identified in the request. Used to support the ‘Officer View’ capability of the HMPPS Workload service which shows statistics on the staff members caseload

Parameters

ParameterInTypeRequiredDescription
code path string true

Responses

StatusDescriptionSchema
200

OK

{
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "grade": "string",
  "email": "string",
  "casesDueToEndInNext4Weeks": "integer",
  "releasesWithinNext4Weeks": "integer",
  "paroleReportsToCompleteInNext4Weeks": "integer"
}
 OfficerView

/registrations/{crn}/flags

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "selfHarm": {
    "description": "string",
    "colour": "string"
  },
  "alerts": {
    "description": "string",
    "colour": "string"
  },
  "safeguarding": {
    "description": "string",
    "colour": "string"
  },
  "information": {
    "description": "string",
    "colour": "string"
  },
  "publicProtection": {
    "description": "string",
    "colour": "string"
  }
}
 RiskSummary

/person/{value}

get

Basic information on the person on probation

Basic information on the person on probation as held in Delius, identified by either the CRN or NOMS number provided in the request. Supports display of the overview person information in the HMPPS Workload service

Parameters

ParameterInTypeRequiredDescription
value path string true
type query string false

Available items:

  • CRN
  • NOMS

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "type": "string"
}
 Person

/offenders/{crn}/documents

get

List of documents held in Delius for the probation case

List of documents available in Delius for the probation case identified by the CRN provided in the request. Document list includes summary information on the type and purpose of document held. Used to support the ‘Document List’ view of the HMPPS Workforce service which is used to give detailed information on the case when allocating to a probation practitioner

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/offenders/{crn}/documents/{id}

get

Fetch a complete document from Delius/Alfresco

Returns the full document identified by the CRN and document id provided in the request. Document is returned in the format stored in Alfresco. Used to support downloading documents from the document list in the HMPPS Workload service

Parameters

ParameterInTypeRequiredDescription
crn path string true
id path string true

Responses

StatusDescriptionSchema
200

OK

{
}
 StreamingResponseBody

/initial-allocations.csv

get

A report of all allocations created by either the Manage a Workforce Allocation tool or Delius, since the start of 2024.

Responses

StatusDescriptionSchema
200

OK

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

/allocation-demand/{crn}/{eventNumber}/probation-record

get

Detailed information on the probation supervision history

Detailed information on all current and previous cases, offences, sentences and management by probation practitioners for the person identified by the CRN and event provided in the request. Supports the ‘Probation Record’ screen of case allocation in the HMPPS Workforce service which is part of the case allocation workflow

Parameters

ParameterInTypeRequiredDescription
crn path string true
eventNumber path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "event": {
    "number": "string",
    "manager": {
      "code": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "teamCode": "string",
      "grade": "string",
      "allocated": "boolean"
    }
  },
  "activeEvents": [
    {
      "sentence": {
        "description": "string",
        "length": "string",
        "startDate": "string",
        "terminationDate": "string"
      },
      "offences": [
        {
          "description": "string",
          "main": "boolean"
        }
      ],
      "manager": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "email": "string",
        "grade": "string"
      }
    }
  ],
  "inactiveEvents": [
    {
      "sentence": {
        "description": "string",
        "length": "string",
        "startDate": "string",
        "terminationDate": "string"
      },
      "offences": [
        {
          "description": "string",
          "main": "boolean"
        }
      ],
      "manager": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "email": "string",
        "grade": "string"
      }
    }
  ]
}
 ProbationRecord

/allocation-demand/{crn}/{eventNumber}/case-view

get

Detailed information on the probation case

Detailed information on the probation case identified by the CRN and event number provided in the request. Returns information on the person on probation, offences, sentence, requirements and case documents held in Delius. Used to support the ‘Case View’ screen of the HMPPS Workforce service which provides a detailed overview of the case when allocating to a probation practitioner

Parameters

ParameterInTypeRequiredDescription
crn path string true
eventNumber path string true

Responses

StatusDescriptionSchema
200

OK

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "gender": "string",
  "pncNumber": "string",
  "mainAddress": {
    "buildingName": "string",
    "addressNumber": "string",
    "streetName": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "noFixedAbode": "boolean",
    "typeVerified": "boolean",
    "typeDescription": "string",
    "startDate": "string"
  },
  "sentence": {
    "description": "string",
    "startDate": "string",
    "length": "string",
    "endDate": "string"
  },
  "offences": [
    {
      "mainCategory": "string",
      "subCategory": "string",
      "mainOffence": "boolean"
    }
  ],
  "requirements": [
    {
      "mainCategory": "string",
      "subCategory": "string",
      "length": "string"
    }
  ],
  "cpsPack": {
    "documentId": "string",
    "documentName": "string",
    "dateCreated": "string",
    "description": "string"
  },
  "preConvictionDocument": {
    "documentId": "string",
    "documentName": "string",
    "dateCreated": "string",
    "description": "string"
  },
  "courtReport": {
    "documentId": "string",
    "documentName": "string",
    "dateCreated": "string",
    "description": "string"
  },
  "age": "integer"
}
 CaseView

/allocation-demand/{crn}/{eventNumber}/allocation

get

Detailed information on the case allocation

Detailed information on the probation case, event and probation practitioners identified in the request. Used to display a summary page after case allocation has been completed in the HMPPS Workforce service

Parameters

ParameterInTypeRequiredDescription
crn path string true
eventNumber path string true
staff query string true
allocatingStaffUsername query string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "staff": {
    "code": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "email": "string",
    "grade": "string"
  },
  "allocatingStaff": {
    "code": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "email": "string",
    "grade": "string"
  },
  "initialAppointment": {
    "date": "string",
    "staff": {
      "code": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "email": "string",
      "grade": "string"
    }
  },
  "ogrs": {
    "lastUpdatedDate": "string",
    "score": "integer"
  },
  "sentence": {
    "description": "string",
    "code": "string",
    "date": "string",
    "lengthValue": "integer",
    "lengthDescription": "string",
    "length": "string"
  },
  "court": {
    "name": "string",
    "appearanceDate": "string"
  },
  "offences": [
    {
      "mainCategory": "string",
      "mainOffence": "boolean"
    }
  ],
  "activeRequirements": [
    {
      "mainCategory": "string",
      "subCategory": "string",
      "length": "string",
      "id": "integer",
      "manager": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "teamCode": "string",
        "grade": "string",
        "allocated": "boolean"
      },
      "isUnpaidWork": "boolean"
    }
  ]
}
 AllocationDemandStaffResponse

/allocation-demand/{crn}/unallocated-events

get

Summary information on all Delius events without a case allocation for a person on probation

Summary information on the person on probation identified by the CRN provided in the request with a list of all active Delius events for that person that do not currently have a case allocation. Used to support choosing the event to allocate in the case allocation workflow of the HMPPS Workforce service

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "activeEvents": [
    {
      "eventNumber": "string",
      "teamCode": "string",
      "providerCode": "string"
    }
  ]
}
 UnallocatedEventsResponse

/allocation-demand/{crn}/risk

get

Detailed information on the risk information held in Delius

Detailed information on the risk factors held and managed in Delius for the person on probation identified by the CRN provided in the request. Supports the ‘Risk’ section of the ‘Case View’ within the HMPPS Workload service which is part of the case allocation workflow

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "activeRegistrations": [
    {
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "notes": "string",
      "flag": {
        "description": "string"
      }
    }
  ],
  "inactiveRegistrations": [
    {
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "notes": "string",
      "flag": {
        "description": "string"
      }
    }
  ],
  "ogrs": {
    "lastUpdatedDate": "string",
    "score": "integer"
  }
}
 RiskRecord

/allocation-demand/impact

get

Summary information on the person on probation and probation practitioner

Summary information on the person on probation and probation practitioner identified by the CRN and staff code provided in the request. Used to support the post-allocation ‘Impact’ screen of the HMPPS Workforce service

Parameters

ParameterInTypeRequiredDescription
crn query string true
staff query string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "staff": {
    "code": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "email": "string",
    "grade": "string"
  }
}
 AllocationImpact

/allocation-demand/choose-practitioner

get

List of summary probation case details with probation practioner details

Summary information on the probation case provided in the request along with a list of probation practitioners associated with the teams provided in the request. Used to support the ‘Choose Practitioner’ screen of the HMPPS Workforce service which is part of the case allocation workflow

Parameters

ParameterInTypeRequiredDescription
crn query string true
teamCode query array false

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "probationStatus": {
    "status": "string",
    "description": "string"
  },
  "communityPersonManager": {
    "code": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "teamCode": "string",
    "grade": "string",
    "allocated": "boolean"
  },
  "teams": {
  }
}
 ChoosePractitionerResponse

/allocation-completed/order-manager

get

Team allocation code for Persons PO

Parameters

ParameterInTypeRequiredDescription
crn query string true
eventNumber query string true

Responses

StatusDescriptionSchema
200

OK

{
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "teamCode": "string",
  "grade": "string",
  "allocated": "boolean"
}
 Manager

/allocation-completed/details

get

Summary case allocation information as currently held in Delius

Summary case allocation information for the probation case identified by the CRN and Event Number in the request. Also provided information on the probation practitioner identified by the staff code in the request. Used to support the post-allocation information page of the HMPPS Workforce service

Parameters

ParameterInTypeRequiredDescription
crn query string true
eventNumber query string true
staffCode query string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "event": {
    "number": "string",
    "manager": {
      "code": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "teamCode": "string",
      "grade": "string",
      "allocated": "boolean"
    }
  },
  "type": "string",
  "initialAppointment": {
    "date": "string",
    "staff": {
      "code": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "email": "string",
      "grade": "string"
    }
  },
  "staff": {
    "code": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "email": "string",
    "grade": "string"
  }
}
 AllocationCompletedResponse

Schemas

CaseAccess

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

UserAccess

NameTypeRequiredDescriptionSchema
access array true CaseAccess

ActiveCasesResponse

NameTypeRequiredDescriptionSchema
code string true
name object true Name
grade string false
email string false
cases array true Case

Case

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
type string true

Name

NameTypeRequiredDescriptionSchema
forename string true
middleName string false
surname string true

AllocationDetailRequest

NameTypeRequiredDescriptionSchema
crn string true
staffCode string true

AllocationDetailRequests

NameTypeRequiredDescriptionSchema
cases array true AllocationDetailRequest

AllocationDetails

NameTypeRequiredDescriptionSchema
cases array true AllocationImpact

AllocationImpact

NameTypeRequiredDescriptionSchema
crn string false
name object false Name
staff object false StaffMember

StaffMember

NameTypeRequiredDescriptionSchema
code string true
name object true Name
email string false
grade string false

AllocationDemandRequest

NameTypeRequiredDescriptionSchema
cases array true AllocationRequest

AllocationRequest

NameTypeRequiredDescriptionSchema
crn string true
eventNumber string true

AllocationDemandResponse

NameTypeRequiredDescriptionSchema
cases array true AllocationResponse

AllocationResponse

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
event object true Event
sentence object false Sentence
initialAppointment object false InitialAppointment
court object true NamedCourt
type string true
probationStatus object true ProbationStatus
communityPersonManager object false Manager
handoverDate string false

Event

NameTypeRequiredDescriptionSchema
number string true
manager object false Manager

InitialAppointment

NameTypeRequiredDescriptionSchema
date string true
staff object true StaffMember

Manager

NameTypeRequiredDescriptionSchema
code string true
name object true Name
teamCode string true
grade string false
allocated boolean true

NamedCourt

NameTypeRequiredDescriptionSchema
name string true

ProbationStatus

NameTypeRequiredDescriptionSchema
status string true
description string true

Sentence

NameTypeRequiredDescriptionSchema
type string true
date string true
length string true

OfficerView

NameTypeRequiredDescriptionSchema
code string true
name object true Name
grade string false
email string false
casesDueToEndInNext4Weeks integer true

The number of sentenced events with an end date in the next four weeks on cases managed by the officer.
releasesWithinNext4Weeks integer true

The number of sentenced custodial events with an “Expected Release Date” key date in the next four weeks on cases managed by the officer.
paroleReportsToCompleteInNext4Weeks integer true

The number of parole reports required in the next four weeks on cases managed by the officer.

RiskItem

NameTypeRequiredDescriptionSchema
description string true
colour string true

RiskSummary

NameTypeRequiredDescriptionSchema
selfHarm object false RiskItem
alerts object false RiskItem
safeguarding object false RiskItem
information object false RiskItem
publicProtection object false RiskItem

Person

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
type string true

DocumentEvent

NameTypeRequiredDescriptionSchema
eventType string true
eventNumber string true
mainOffence string true

PersonDocument

NameTypeRequiredDescriptionSchema
id string false
name string true
relatedTo object true RelatedTo
dateSaved string false
dateCreated string false
sensitive boolean true

RelatedTo

NameTypeRequiredDescriptionSchema
type string true
name string true
event object false DocumentEvent
description string true

StreamingResponseBody

PrEvent

NameTypeRequiredDescriptionSchema
sentence object true PrSentence
offences array true PrOffence
manager object false StaffMember

PrOffence

NameTypeRequiredDescriptionSchema
description string true
main boolean true

PrSentence

NameTypeRequiredDescriptionSchema
description string true
length string true
startDate string true
terminationDate string false

ProbationRecord

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
event object true Event
activeEvents array true PrEvent
inactiveEvents array true PrEvent

CaseView

NameTypeRequiredDescriptionSchema
name object true Name
dateOfBirth string true
gender string false
pncNumber string false
mainAddress object false CvAddress
sentence object true CvSentence
offences array true CvOffence
requirements array true CvRequirement
cpsPack object false CvDocument
preConvictionDocument object false CvDocument
courtReport object false CvDocument
age integer true

CvAddress

NameTypeRequiredDescriptionSchema
buildingName string false
addressNumber string false
streetName string false
town string false
county string false
postcode string false
noFixedAbode boolean true
typeVerified boolean true
typeDescription string false
startDate string true

CvDocument

NameTypeRequiredDescriptionSchema
documentId string true
documentName string true
dateCreated string true
description string false

CvOffence

NameTypeRequiredDescriptionSchema
mainCategory string true
subCategory string true
mainOffence boolean true

CvRequirement

NameTypeRequiredDescriptionSchema
mainCategory string true
subCategory string false
length string true

CvSentence

NameTypeRequiredDescriptionSchema
description string true
startDate string true
length string true
endDate string true

AllocationDemandSentence

NameTypeRequiredDescriptionSchema
description string true
code string true
date string true
lengthValue integer false
lengthDescription string false
length string true

AllocationDemandStaffResponse

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
staff object false StaffMember
allocatingStaff object false StaffMember
initialAppointment object false InitialAppointment
ogrs object false RiskOGRS
sentence object false AllocationDemandSentence
court object false Court
offences array true Offence
activeRequirements array true Requirement

Court

NameTypeRequiredDescriptionSchema
name string true
appearanceDate string true

Offence

NameTypeRequiredDescriptionSchema
mainCategory string true
mainOffence boolean true

Requirement

NameTypeRequiredDescriptionSchema
mainCategory string true
subCategory string false
length string true
id integer true
manager object true Manager
isUnpaidWork boolean true

RiskOGRS

NameTypeRequiredDescriptionSchema
lastUpdatedDate string true
score integer true

ActiveEvent

NameTypeRequiredDescriptionSchema
eventNumber string true
teamCode string true
providerCode string true

UnallocatedEventsResponse

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
activeEvents array true ActiveEvent

RegistrationFlag

NameTypeRequiredDescriptionSchema
description string true

RiskRecord

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
activeRegistrations array true RiskRegistration
inactiveRegistrations array true RiskRegistration
ogrs object false RiskOGRS

RiskRegistration

NameTypeRequiredDescriptionSchema
description string true
startDate string true
endDate string false
notes string false
flag object false RegistrationFlag

ChoosePractitionerResponse

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
probationStatus object true ProbationStatus
communityPersonManager object false Manager
teams object true

AllocationCompletedResponse

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
event object true Event
type string true
initialAppointment object false InitialAppointment
staff object false StaffMember