Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/access/{crn}

get

Parameters

ParameterInTypeRequiredDescription
username path string true
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "userExcluded": "boolean",
  "userRestricted": "boolean",
  "exclusionMessage": "string",
  "restrictionMessage": "string"
}
 CaseAccess

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

/case-data/{crn}/{eventId}

get

Detailed information on the probation case

Full details of the probation case for the purposes of creating a new unpaid work assessment. The service will return case information for the CRN and Event Number supplied in the request. Only active personal contacts and personal circumstances are included

Parameters

ParameterInTypeRequiredDescription
crn path string true
eventId path integer true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "gender": "string",
  "genderIdentity": "string",
  "croNumber": "string",
  "pncNumber": "string",
  "aliases": [
    {
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "dateOfBirth": "string"
    }
  ],
  "emailAddress": "string",
  "phoneNumbers": [
    {
      "type": "string",
      "number": "string"
    }
  ],
  "mainAddress": {
    "buildingName": "string",
    "addressNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string"
  },
  "ethnicity": "string",
  "disabilities": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "condition": {
        "code": "string",
        "description": "string"
      },
      "notes": "string"
    }
  ],
  "provisions": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "category": {
        "code": "string",
        "description": "string"
      },
      "notes": "string"
    }
  ],
  "language": {
    "requiresInterpreter": "boolean",
    "primaryLanguage": "string"
  },
  "personalCircumstances": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "subType": {
        "code": "string",
        "description": "string"
      },
      "notes": "string",
      "evidenced": "boolean"
    }
  ],
  "personalContacts": [
    {
      "relationship": "string",
      "relationshipType": {
        "code": "string",
        "description": "string"
      },
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "telephoneNumber": "string",
      "mobileNumber": "string",
      "address": {
        "buildingName": "string",
        "addressNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string"
      }
    }
  ],
  "mappaRegistration": {
    "startDate": "string",
    "level": {
      "code": "string",
      "description": "string"
    },
    "category": {
      "code": "string",
      "description": "string"
    }
  },
  "registerFlags": [
    {
      "code": "string",
      "description": "string",
      "riskColour": "string"
    }
  ],
  "sentence": {
    "startDate": "string",
    "mainOffence": {
      "category": {
        "code": "string",
        "description": "string"
      },
      "subCategory": {
        "code": "string",
        "description": "string"
      }
    }
  }
}
 CaseDetails

/case-data/{crn}/personal-details

get

Details of all active personal contacts and personal circumstances for a person on probation

Details of all active personal contacts and personal circumstances related to the probation case identified by the CRN provided in the request. The service will return personal contacts and personal circumstances that are active on the date of the request. Used to access any additional information held in Delius when cloning an existing assessment

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "personalCircumstances": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "subType": {
        "code": "string",
        "description": "string"
      },
      "notes": "string",
      "evidenced": "boolean"
    }
  ],
  "personalContacts": [
    {
      "relationship": "string",
      "relationshipType": {
        "code": "string",
        "description": "string"
      },
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "telephoneNumber": "string",
      "mobileNumber": "string",
      "address": {
        "buildingName": "string",
        "addressNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string"
      }
    }
  ]
}
 PersonalDetails

Schemas

CaseAccess

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

Address

NameTypeRequiredDescriptionSchema
buildingName string false
addressNumber string false
streetName string false
district string false
town string false
county string false
postcode string false

Alias

NameTypeRequiredDescriptionSchema
name object true Name
dateOfBirth string true

CaseDetails

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
dateOfBirth string true
gender string false
genderIdentity string false
croNumber string false
pncNumber string false
aliases array false Alias
emailAddress string false
phoneNumbers array false PhoneNumber
mainAddress object false Address
ethnicity string false
disabilities array false Disability
provisions array false Provision
language object false Language
personalCircumstances array false PersonalCircumstance
personalContacts array false PersonalContact
mappaRegistration object false MappaRegistration
registerFlags array false RegisterFlag
sentence object false Sentence

Disability

NameTypeRequiredDescriptionSchema
type object true Type
condition object false Type
notes string false

Language

NameTypeRequiredDescriptionSchema
requiresInterpreter boolean true
primaryLanguage string true

MainOffence

NameTypeRequiredDescriptionSchema
category object true Type
subCategory object true Type

MappaRegistration

NameTypeRequiredDescriptionSchema
startDate string true
level object true Type
category object true Type

Name

NameTypeRequiredDescriptionSchema
forename string true
middleName string false
surname string true

PersonalCircumstance

NameTypeRequiredDescriptionSchema
type object true Type
subType object false Type
notes string false
evidenced boolean true

PersonalContact

NameTypeRequiredDescriptionSchema
relationship string true
relationshipType object true Type
name object true Name
telephoneNumber string false
mobileNumber string false
address object false Address

PhoneNumber

NameTypeRequiredDescriptionSchema
type string true
number string true

Provision

NameTypeRequiredDescriptionSchema
type object true Type
category object false Type
notes string false

RegisterFlag

NameTypeRequiredDescriptionSchema
code string true
description string true
riskColour string false

Sentence

NameTypeRequiredDescriptionSchema
startDate string true
mainOffence object true MainOffence

Type

NameTypeRequiredDescriptionSchema
code string true
description string true

PersonalDetails

NameTypeRequiredDescriptionSchema
crn string true
personalCircumstances array true PersonalCircumstance
personalContacts array true PersonalContact