API Reference

The following documentation is also available in these formats:

API Reference v1.0

/probation-cases/access

get

Parameters

Parameter	In	Type	Required	Description
username	query	string	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "access": [ { "crn": "A123456", "userExcluded": false, "userRestricted": false } ] }`	UserAccess

{
  "access": [
    {
      "crn": "A123456",
      "userExcluded": false,
      "userRestricted": false
    }
  ]
}

UserAccess

post

Parameters

Parameter	In	Type	Required	Description
username	query	string	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "access": [ { "crn": "A123456", "userExcluded": false, "userRestricted": false } ] }`	UserAccess

{
  "access": [
    {
      "crn": "A123456",
      "userExcluded": false,
      "userRestricted": false
    }
  ]
}

UserAccess

/search/probation-cases

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/reference-data

get

Gets delius reference data

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "probationReferenceData": { } }`	ProbationReferenceData

{
  "probationReferenceData": {
  }
}

ProbationReferenceData

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

get

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

Parameters

Parameter	In	Type	Required	Description
nomsId	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string", "nomsId": "string" }`	PersonIdentifier

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

PersonIdentifier

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

get

Check if crn exists in delius for the provided crn

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string", "existsInDelius": "boolean" }`	PersonExists

{
  "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

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
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

{
  "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

/case/{crn}/addresses

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "contactDetails": { "addresses": [ { "noFixedAbode": "boolean", "type": { "code": "string", "description": "string" }, "buildingName": "string", "addressNumber": "string", "streetName": "string", "town": "string", "district": "string", "county": "string", "postcode": "string", "from": "string", "to": "string", "notes": "string" } ] } }`	AddressWrapper

{
  "contactDetails": {
    "addresses": [
      {
        "noFixedAbode": "boolean",
        "type": {
          "code": "string",
          "description": "string"
        },
        "buildingName": "string",
        "addressNumber": "string",
        "streetName": "string",
        "town": "string",
        "district": "string",
        "county": "string",
        "postcode": "string",
        "from": "string",
        "to": "string",
        "notes": "string"
      }
    ]
  }
}

AddressWrapper

Schemas

CrnRequest

Name	Type	Required	Description	Schema
crns	array	true

CaseAccess

Name	Type	Required
crn	string	true
userExcluded	boolean	true
userRestricted	boolean	true
exclusionMessage	string	false
restrictionMessage	string	false

UserAccess

Name	Type	Required	Description	Schema
access	array	true		CaseAccess

SearchRequest

Name	Type	Required
firstName	string	false
surname	string	false
dateOfBirth	string	false
pncNumber	string	false
crn	string	false
nomsNumber	string	false
includeAliases	boolean	true

CaseAlias

Name	Type	Required
firstName	string	true
surname	string	true
dateOfBirth	string	true
gender	string	true
middleNames	array	true

CaseDisability

Name	Type	Required	Schema
disabilityType	object	true	CodedValue
condition	object	false	CodedValue
startDate	string	false
endDate	string	false
notes	string	false

CaseProfile

Name	Type	Required	Schema
ethnicity	string	false
nationality	string	false
religion	string	false
sexualOrientation	string	false
disabilities	array	true	CaseDisability

CodedValue

Name	Type	Required	Description	Schema
code	string	true
description	string	true

ContactDetails

Name	Type	Required	Description	Schema
phoneNumbers	array	true		PhoneNumber
emailAddresses	array	true

OtherIds

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

PhoneNumber

Name	Type	Required	Description	Schema
number	string	true
type	string	true

ProbationCaseDetail

Name	Type	Required	Schema
otherIds	object	true	OtherIds
firstName	string	true
surname	string	true
dateOfBirth	string	true
gender	string	true
middleNames	array	true
offenderProfile	object	true	CaseProfile
contactDetails	object	false	ContactDetails
offenderAliases	array	true	CaseAlias
activeProbationManagedSentence	boolean	true
currentRestriction	boolean	true
restrictionMessage	string	false
currentExclusion	boolean	true
exclusionMessage	string	false
age	integer	true

ProbationReferenceData

Name	Type	Required	Description	Schema
probationReferenceData	object	true

RefData

Name	Type	Required	Description	Schema
code	string	true	reference data code
description	string	true	reference data description

PersonIdentifier

Name	Type	Required	Description	Schema
crn	string	true
nomsId	string	true

PersonExists

Name	Type	Required	Description	Schema
crn	string	true
existsInDelius	boolean	true

CourtAppearance

Name	Type	Required
type	string	true
date	string	true
court	string	true
plea	string	false

DynamicRiskRegistration

Name	Type	Required
code	string	true
description	string	true
startDate	string	true
reviewDate	string	false
notes	string	false

Manager

Name	Type	Required	Schema
code	string	true
name	object	true	Name
username	string	false
email	string	false
telephoneNumber	string	false
team	object	true	Team
allocated	boolean	true

MappaDetail

Name	Type	Required
level	integer	false
levelDescription	string	false
category	integer	false
categoryDescription	string	false
startDate	string	true
reviewDate	string	false
notes	string	false

Name

Name	Type	Required	Description	Schema
forename	string	true
surname	string	true

Offence

Name	Type	Required	Schema
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

Name	Type	Required	Description	Schema
code	string	true
description	string	true

PersonStatusRegistration

Name	Type	Required
code	string	true
description	string	true
startDate	string	true
reviewDate	string	false
notes	string	false

Provider

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Sentence

Name	Type	Required
description	string	true
date	string	true
length	integer	false
lengthUnits	string	false
custodial	boolean	true

Supervision

Name	Type	Required	Schema
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

Name	Type	Required	Schema
communityManager	object	true	Manager
mappaDetail	object	false	MappaDetail
supervisions	array	true	Supervision
dynamicRisks	array	true	DynamicRiskRegistration
personStatus	array	true	PersonStatusRegistration

Team

Name	Type	Required	Schema
code	string	true
description	string	true
email	string	false
telephoneNumber	string	false
provider	object	true	Provider

AddressWrapper

Name	Type	Required	Description	Schema
contactDetails	object	true		ContactDetailAddresses

CaseAddress

Name	Type	Required	Schema
noFixedAbode	boolean	true
type	object	true	CodedValue
buildingName	string	false
addressNumber	string	false
streetName	string	false
town	string	false
district	string	false
county	string	false
postcode	string	false
from	string	false
to	string	false
notes	string	false

ContactDetailAddresses

Name	Type	Required	Description	Schema
addresses	array	true		CaseAddress