Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/probation-cases/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "identifiers": {
    "crn": "string",
    "noms": "string",
    "pnc": "string",
    "cro": "string"
  },
  "person": {
    "name": {
      "surname": "string",
      "forename": "string",
      "middleNames": [
        {
        }
      ]
    },
    "dateOfBirth": "string",
    "gender": {
      "code": "string",
      "description": "string"
    }
  },
  "profile": {
    "language": {
      "code": "string",
      "description": "string"
    },
    "ethnicity": {
      "code": "string",
      "description": "string"
    },
    "religion": {
      "code": "string",
      "description": "string"
    }
  },
  "contactDetails": {
    "mainAddress": {
      "noFixedAbode": "boolean",
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string"
    },
    "emailAddress": "string",
    "telephoneNumber": "string",
    "mobileNumber": "string"
  }
}
 CaseDetails

/probation-cases/{crn}/release

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "lastRelease": {
    "date": "string",
    "notes": "string",
    "institution": {
      "institutionId": "integer",
      "isEstablishment": "boolean",
      "code": "string",
      "description": "string",
      "institutionName": "string",
      "establishmentType": {
        "code": "string",
        "description": "string"
      },
      "isPrivate": "boolean",
      "nomsPrisonInstitutionCode": "string"
    },
    "reason": {
      "code": "string",
      "description": "string"
    }
  },
  "lastRecall": {
    "date": "string",
    "reason": {
      "code": "string",
      "description": "string"
    },
    "notes": "string"
  }
}
 ReleaseRecall

/probation-cases/{crn}/registrations

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "registrations": [
    {
      "registrationId": "integer",
      "offenderId": "integer",
      "register": {
        "code": "string",
        "description": "string"
      },
      "type": {
        "code": "string",
        "description": "string"
      },
      "riskColour": "string",
      "startDate": "string",
      "nextReviewDate": "string",
      "reviewPeriodMonths": "integer",
      "notes": "string",
      "registeringTeam": {
        "code": "string",
        "description": "string"
      },
      "registeringOfficer": {
        "code": "string",
        "forename": "string",
        "surname": "string",
        "isUnallocated": "boolean"
      },
      "registeringProbationArea": {
        "code": "string",
        "description": "string"
      },
      "registerLevel": {
        "code": "string",
        "description": "string"
      },
      "registerCategory": {
        "code": "string",
        "description": "string"
      },
      "warnUser": "boolean",
      "active": "boolean",
      "registrationReviews": [
        {
          "reviewDate": "string",
          "reviewDateDue": "string",
          "notes": "string",
          "reviewingTeam": {
            "code": "string",
            "description": "string"
          },
          "reviewingOfficer": {
            "code": "string",
            "forename": "string",
            "surname": "string",
            "isUnallocated": "boolean"
          },
          "completed": "boolean"
        }
      ]
    }
  ]
}
 Registrations

Schemas

Address

NameTypeRequiredDescriptionSchema
noFixedAbode boolean true
buildingName string false
buildingNumber string false
streetName string false
district string false
town string false
county string false
postcode string false

CaseDetails

NameTypeRequiredDescriptionSchema
identifiers object true Identifiers
person object true Person
profile object false Profile
contactDetails object false ContactDetails

CodeDescription

NameTypeRequiredDescriptionSchema
code string true
description string true

ContactDetails

NameTypeRequiredDescriptionSchema
mainAddress object false Address
emailAddress string false
telephoneNumber string false
mobileNumber string false

Identifiers

NameTypeRequiredDescriptionSchema
crn string true
noms string false
pnc string false
cro string false

Name

NameTypeRequiredDescriptionSchema
surname string true
forename string true
middleNames array true

Person

NameTypeRequiredDescriptionSchema
name object true Name
dateOfBirth string true
gender object false CodeDescription

Profile

NameTypeRequiredDescriptionSchema
language object false CodeDescription
ethnicity object false CodeDescription
religion object false CodeDescription

Institution

NameTypeRequiredDescriptionSchema
institutionId integer true
isEstablishment boolean true
code string true
description string true
institutionName string false
establishmentType object false CodeDescription
isPrivate boolean false
nomsPrisonInstitutionCode string false

Recall

NameTypeRequiredDescriptionSchema
date string true
reason object true CodeDescription
notes string false

Release

NameTypeRequiredDescriptionSchema
date string true
notes string false
institution object false Institution
reason object true CodeDescription

ReleaseRecall

NameTypeRequiredDescriptionSchema
lastRelease object false Release
lastRecall object false Recall

Officer

NameTypeRequiredDescriptionSchema
code string true
forename string true
surname string true
isUnallocated boolean true

Registration

NameTypeRequiredDescriptionSchema
registrationId integer true
offenderId integer true
register object false CodeDescription
type object true CodeDescription
riskColour string false
startDate string true
nextReviewDate string false
reviewPeriodMonths integer false
notes string false
registeringTeam object true CodeDescription
registeringOfficer object true Officer
registeringProbationArea object true CodeDescription
registerLevel object false CodeDescription
registerCategory object false CodeDescription
warnUser boolean true
active boolean true
registrationReviews array true Review

Registrations

NameTypeRequiredDescriptionSchema
registrations array true Registration

Review

NameTypeRequiredDescriptionSchema
reviewDate string true
reviewDateDue string false
notes string false
reviewingTeam object true CodeDescription
reviewingOfficer object true Officer
completed boolean true