Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/reference-data

get

Gets delius reference data

Responses

StatusDescriptionSchema
200

OK

{
  "probationReferenceData": {
  }
}
 ProbationReferenceData

/identifier-converter/noms-to-crn/{nomsId}

get

Gets the corresponding CRN from delius for the provided nomsId if found

Parameters

ParameterInTypeRequiredDescription
nomsId path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "nomsId": "string"
}
 PersonIdentifier

/exists-in-delius/crn/{crn}

get

Check if crn exists in delius for the provided crn

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "existsInDelius": "boolean"
}
 PersonExists

/case/{crn}/supervisions

get

Get a list of supervisions (called “events” in Delius) for a probation case, by CRN

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "communityManager": {
    "code": "string",
    "name": {
      "forename": "string",
      "surname": "string"
    },
    "username": "string",
    "email": "string",
    "telephoneNumber": "string",
    "team": {
      "code": "string",
      "description": "string",
      "email": "string",
      "telephoneNumber": "string",
      "provider": {
        "code": "string",
        "description": "string"
      }
    },
    "allocated": "boolean"
  },
  "mappaDetail": {
    "level": "integer",
    "levelDescription": "string",
    "category": "integer",
    "categoryDescription": "string",
    "startDate": "string",
    "reviewDate": "string",
    "notes": "string"
  },
  "supervisions": [
    {
      "number": "integer",
      "active": "boolean",
      "date": "string",
      "sentence": {
        "description": "string",
        "date": "string",
        "length": "integer",
        "lengthUnits": "string",
        "custodial": "boolean"
      },
      "mainOffence": {
        "date": "string",
        "count": "integer",
        "code": "string",
        "description": "string",
        "mainCategory": {
          "code": "string",
          "description": "string"
        },
        "subCategory": {
          "code": "string",
          "description": "string"
        },
        "schedule15SexualOffence": "boolean",
        "schedule15ViolentOffence": "boolean"
      },
      "additionalOffences": [
        {
          "date": "string",
          "count": "integer",
          "code": "string",
          "description": "string",
          "mainCategory": {
            "code": "string",
            "description": "string"
          },
          "subCategory": {
            "code": "string",
            "description": "string"
          },
          "schedule15SexualOffence": "boolean",
          "schedule15ViolentOffence": "boolean"
        }
      ],
      "courtAppearances": [
        {
          "type": "string",
          "date": "string",
          "court": "string",
          "plea": "string"
        }
      ]
    }
  ],
  "dynamicRisks": [
    {
      "code": "RCCO",
      "description": "Child Concerns",
      "startDate": "string",
      "reviewDate": "string",
      "notes": "string"
    }
  ],
  "personStatus": [
    {
      "code": "ASFO",
      "description": "Serious Further Offence - Subject to SFO review/investigation",
      "startDate": "string",
      "reviewDate": "string",
      "notes": "string"
    }
  ]
}
 SupervisionResponse

Schemas

ProbationReferenceData

NameTypeRequiredDescriptionSchema
probationReferenceData object true

RefData

NameTypeRequiredDescriptionSchema
code string true

reference data code
description string true

reference data description

PersonIdentifier

NameTypeRequiredDescriptionSchema
crn string true
nomsId string true

PersonExists

NameTypeRequiredDescriptionSchema
crn string true
existsInDelius boolean true

CourtAppearance

NameTypeRequiredDescriptionSchema
type string true
date string true
court string true
plea string false

DynamicRiskRegistration

NameTypeRequiredDescriptionSchema
code string true
description string true
startDate string true
reviewDate string false
notes string false

Manager

NameTypeRequiredDescriptionSchema
code string true
name object true Name
username string false
email string false
telephoneNumber string false
team object true Team
allocated boolean true

MappaDetail

NameTypeRequiredDescriptionSchema
level integer false
levelDescription string false
category integer false
categoryDescription string false
startDate string true
reviewDate string false
notes string false

Name

NameTypeRequiredDescriptionSchema
forename string true
surname string true

Offence

NameTypeRequiredDescriptionSchema
date string false
count integer false
code string true
description string true
mainCategory object false OffenceCategory
subCategory object false OffenceCategory
schedule15SexualOffence boolean false
schedule15ViolentOffence boolean false

OffenceCategory

NameTypeRequiredDescriptionSchema
code string true
description string true

PersonStatusRegistration

NameTypeRequiredDescriptionSchema
code string true
description string true
startDate string true
reviewDate string false
notes string false

Provider

NameTypeRequiredDescriptionSchema
code string true
description string true

Sentence

NameTypeRequiredDescriptionSchema
description string true
date string true
length integer false
lengthUnits string false
custodial boolean true

Supervision

NameTypeRequiredDescriptionSchema
number integer true
active boolean true
date string false
sentence object false Sentence
mainOffence object false Offence
additionalOffences array false Offence
courtAppearances array false CourtAppearance

SupervisionResponse

NameTypeRequiredDescriptionSchema
communityManager object true Manager
mappaDetail object false MappaDetail
supervisions array true Supervision
dynamicRisks array true DynamicRiskRegistration
personStatus array true PersonStatusRegistration

Team

NameTypeRequiredDescriptionSchema
code string true
description string true
email string false
telephoneNumber string false
provider object true Provider