Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/case-details/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "crn": "string",
  "tier": "string",
  "dateOfBirth": "string",
  "nomisId": "string",
  "region": "string",
  "keyWorker": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "unallocated": "boolean"
  },
  "inCustody": "boolean",
  "sentences": [
    {
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "programmeRequirement": "boolean",
      "unpaidWorkHoursOrdered": "integer",
      "unpaidWorkMinutesCompleted": "integer",
      "rarDaysOrdered": "integer",
      "rarDaysCompleted": "integer"
    }
  ]
}
 CaseDetails

/case-details/{crn}/first-appointment-date

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "appointmentDate": "string"
}
 FirstAppointment

Schemas

CaseDetails

NameTypeRequiredDescriptionSchema
name object true Name
crn string true
tier string false
dateOfBirth string true
nomisId string false
region string false
keyWorker object true Manager
inCustody boolean true
sentences array true Sentence

Manager

NameTypeRequiredDescriptionSchema
name object false Name
unallocated boolean true

Name

NameTypeRequiredDescriptionSchema
forename string true
middleName string false
surname string true

Sentence

NameTypeRequiredDescriptionSchema
description string false
startDate string false
endDate string false
programmeRequirement boolean true
unpaidWorkHoursOrdered integer true
unpaidWorkMinutesCompleted integer true
rarDaysOrdered integer true
rarDaysCompleted integer true

FirstAppointment

NameTypeRequiredDescriptionSchema
appointmentDate string false