Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/access

get

Parameters

ParameterInTypeRequiredDescription
username query string false
crns query array true

Responses

StatusDescriptionSchema
200

OK

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

post

Parameters

ParameterInTypeRequiredDescription
username query string false

Responses

StatusDescriptionSchema
200

OK

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

/probation-cases/summaries

get

Parameters

ParameterInTypeRequiredDescription
crns query array true

Responses

StatusDescriptionSchema
200

OK

{
  "cases": [
    {
      "crn": "string",
      "nomsId": "string",
      "pnc": "string",
      "name": {
        "forename": "string",
        "surname": "string",
        "middleNames": [
          {
          }
        ]
      },
      "dateOfBirth": "string",
      "gender": "string",
      "profile": {
        "ethnicity": "string",
        "genderIdentity": "string",
        "nationality": "string",
        "religion": "string"
      },
      "manager": {
        "team": {
          "code": "string",
          "name": "string",
          "ldu": {
            "code": "string",
            "name": "string"
          },
          "borough": {
            "code": "string",
            "description": "string"
          },
          "startDate": "string",
          "endDate": "string"
        }
      },
      "currentExclusion": "boolean",
      "currentRestriction": "boolean"
    }
  ]
}
 CaseSummaries

post

Responses

StatusDescriptionSchema
200

OK

{
  "cases": [
    {
      "crn": "string",
      "nomsId": "string",
      "pnc": "string",
      "name": {
        "forename": "string",
        "surname": "string",
        "middleNames": [
          {
          }
        ]
      },
      "dateOfBirth": "string",
      "gender": "string",
      "profile": {
        "ethnicity": "string",
        "genderIdentity": "string",
        "nationality": "string",
        "religion": "string"
      },
      "manager": {
        "team": {
          "code": "string",
          "name": "string",
          "ldu": {
            "code": "string",
            "name": "string"
          },
          "borough": {
            "code": "string",
            "description": "string"
          },
          "startDate": "string",
          "endDate": "string"
        }
      },
      "currentExclusion": "boolean",
      "currentRestriction": "boolean"
    }
  ]
}
 CaseSummaries

/teams/managingCase/{crn}

get

List all teams involved in managing the probation case

A probation case may be managed by staff members who are associated with multiple teams in Delius. Approve Premises users need to view all applications that may be covered by direct colleagues in order to cover absence and other workload-related issues. Respond with a list of every team code that covers the probation case identified by the CRN to enable the Approved Premises service to present the relevant list of Approved Premises applications to it’s users.

Parameters

ParameterInTypeRequiredDescription
crn path string true
staffCode query string false

Responses

StatusDescriptionSchema
200

OK

{
  "teamCodes": [
    {
    }
  ]
}
 TeamCodeResponse

/staff

get

Get the staff details by code

Parameters

ParameterInTypeRequiredDescription
code query string true

Responses

StatusDescriptionSchema
200

OK

{
  "email": "string",
  "telephoneNumber": "string",
  "staffIdentifier": "integer",
  "teams": [
    {
      "code": "string",
      "name": "string",
      "ldu": {
        "code": "string",
        "name": "string"
      },
      "borough": {
        "code": "string",
        "description": "string"
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "probationArea": {
    "code": "string",
    "description": "string"
  },
  "username": "string",
  "name": {
    "forename": "string",
    "surname": "string",
    "middleName": "string"
  },
  "code": "string",
  "active": "boolean"
}
 StaffDetail

/staff/{userName}

get

Get the staff details by username

Parameters

ParameterInTypeRequiredDescription
userName path string true

Responses

StatusDescriptionSchema
200

OK

{
  "email": "string",
  "telephoneNumber": "string",
  "staffIdentifier": "integer",
  "teams": [
    {
      "code": "string",
      "name": "string",
      "ldu": {
        "code": "string",
        "name": "string"
      },
      "borough": {
        "code": "string",
        "description": "string"
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "probationArea": {
    "code": "string",
    "description": "string"
  },
  "username": "string",
  "name": {
    "forename": "string",
    "surname": "string",
    "middleName": "string"
  },
  "code": "string",
  "active": "boolean"
}
 StaffDetail

/probation-cases/{crn}/details

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "case": {
    "crn": "string",
    "nomsId": "string",
    "pnc": "string",
    "name": {
      "forename": "string",
      "surname": "string",
      "middleNames": [
        {
        }
      ]
    },
    "dateOfBirth": "string",
    "gender": "string",
    "profile": {
      "ethnicity": "string",
      "genderIdentity": "string",
      "nationality": "string",
      "religion": "string"
    },
    "manager": {
      "team": {
        "code": "string",
        "name": "string",
        "ldu": {
          "code": "string",
          "name": "string"
        },
        "borough": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string",
        "endDate": "string"
      }
    },
    "currentExclusion": "boolean",
    "currentRestriction": "boolean"
  },
  "offences": [
    {
      "id": "integer",
      "code": "string",
      "description": "string",
      "date": "string",
      "main": "boolean",
      "eventId": "integer",
      "eventNumber": "string"
    }
  ],
  "registrations": [
    {
      "code": "string",
      "description": "string",
      "startDate": "string"
    }
  ],
  "mappaDetail": {
    "level": "integer",
    "levelDescription": "string",
    "category": "integer",
    "categoryDescription": "string",
    "startDate": "string",
    "lastUpdated": "string"
  },
  "careLeaver": "boolean",
  "veteran": "boolean"
}
 CaseDetail

/probation-case/{crn}/referrals

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "referrals": [
    {
      "referralDate": "string",
      "expectedArrivalDate": "string",
      "expectedDepartureDate": "string",
      "decisionDate": "string",
      "approvedPremises": {
        "description": "string"
      }
    }
  ]
}
 ExistingReferrals

/probation-case/{crn}/referrals/{bookingId}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true
bookingId path string true

Responses

StatusDescriptionSchema
200

OK

{
  "referral": {
    "referralDate": "string",
    "expectedArrivalDate": "string",
    "expectedDepartureDate": "string",
    "decisionDate": "string",
    "approvedPremises": {
      "description": "string"
    }
  },
  "arrivedAt": "string",
  "departedAt": "string"
}
 ReferralDetail

/documents/{crn}/{id}

get

Download document content

Parameters

ParameterInTypeRequiredDescription
crn path string true
id path string true

Responses

StatusDescriptionSchema
200

OK

{
}
 StreamingResponseBody

/documents/{crn}/all

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.

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

/approved-premises/{code}/staff

get

List all members of staff that are keyworkers in the Approved Premises

An Approved Premises is defined in Delius as part of reference data. Probation staff members can be linked to an Approved Premises as either staff members or keyworkers via the “Approved Premises and Teams” screen of the Delius user interface. Keyworkers are defined via the “Approved Premises and Key Workers” screen of the Delius user interface. Respond with a list of all members of staff defined as keyworkers for the Approved Premises identified by the requested code.

Parameters

ParameterInTypeRequiredDescription
code path string true
keyWorker query boolean false
pageable query object false

Responses

StatusDescriptionSchema
200

OK

{
  "content": [
    {
      "code": "string",
      "name": {
        "forename": "string",
        "surname": "string",
        "middleName": "string"
      },
      "grade": {
        "code": "string",
        "description": "string"
      },
      "keyWorker": "boolean"
    }
  ],
  "page": {
    "size": "integer",
    "number": "integer",
    "totalElements": "integer",
    "totalPages": "integer"
  }
}
 PagedModelStaffResponse

Schemas

CaseAccess

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

UserAccess

NameTypeRequiredDescriptionSchema
access array true CaseAccess

Borough

NameTypeRequiredDescriptionSchema
code string true
description string true

CaseSummaries

NameTypeRequiredDescriptionSchema
cases array true CaseSummary

CaseSummary

NameTypeRequiredDescriptionSchema
crn string true
nomsId string false
pnc string false
name object true Name
dateOfBirth string true
gender string false
profile object false Profile
manager object true Manager
currentExclusion boolean true
currentRestriction boolean true

Ldu

NameTypeRequiredDescriptionSchema
code string true
name string true

Manager

NameTypeRequiredDescriptionSchema
team object true Team

Name

NameTypeRequiredDescriptionSchema
forename string true
surname string true
middleNames array true

Profile

NameTypeRequiredDescriptionSchema
ethnicity string false
genderIdentity string false
nationality string false
religion string false

Team

NameTypeRequiredDescriptionSchema
code string true
name string true
ldu object true Ldu
borough object false Borough
startDate string true
endDate string false

TeamCodeResponse

NameTypeRequiredDescriptionSchema
teamCodes array true

PersonName

NameTypeRequiredDescriptionSchema
forename string true
surname string true
middleName string false

ProbationArea

NameTypeRequiredDescriptionSchema
code string true
description string true

StaffDetail

NameTypeRequiredDescriptionSchema
email string false
telephoneNumber string false
staffIdentifier integer true
teams array true Team
probationArea object true ProbationArea
username string false
name object true PersonName
code string true
active boolean true

CaseDetail

NameTypeRequiredDescriptionSchema
case object true CaseSummary
offences array true Offence
registrations array true Registration
mappaDetail object false MappaDetail
careLeaver boolean true
veteran boolean true

MappaDetail

NameTypeRequiredDescriptionSchema
level integer false
levelDescription string false
category integer false
categoryDescription string false
startDate string true
lastUpdated string true

Offence

NameTypeRequiredDescriptionSchema
id integer true
code string true
description string true
date string false
main boolean true
eventId integer true
eventNumber string true

Registration

NameTypeRequiredDescriptionSchema
code string true
description string true
startDate string true

ApReferral

NameTypeRequiredDescriptionSchema
referralDate string true
expectedArrivalDate string false
expectedDepartureDate string false
decisionDate string false
approvedPremises object true ApprovedPremises

ApprovedPremises

NameTypeRequiredDescriptionSchema
description string true

ExistingReferrals

NameTypeRequiredDescriptionSchema
crn string true
referrals array true ApReferral

ReferralDetail

NameTypeRequiredDescriptionSchema
referral object true ApReferral
arrivedAt string false
departedAt string false

StreamingResponseBody

DocumentResponse

NameTypeRequiredDescriptionSchema
id string false
level string true
eventNumber string false
filename string true
typeCode string true
typeDescription string true
dateSaved string true
dateCreated string true
description string false

Pageable

NameTypeRequiredDescriptionSchema
page integer false
size integer false
sort array false

PageMetadata

NameTypeRequiredDescriptionSchema
size integer false
number integer false
totalElements integer false
totalPages integer false

PagedModelStaffResponse

NameTypeRequiredDescriptionSchema
content array false StaffResponse
page object false PageMetadata

StaffGrade

NameTypeRequiredDescriptionSchema
code string true
description string true

StaffResponse

NameTypeRequiredDescriptionSchema
code string true
name object true PersonName
grade object false StaffGrade
keyWorker boolean true