Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/access

get

Parameters

ParameterInTypeRequiredDescription
username path string true
crns query array true

Responses

StatusDescriptionSchema
200

OK

{
  "access": [
    {
      "crn": "string",
      "userExcluded": "boolean",
      "userRestricted": "boolean",
      "exclusionMessage": "string",
      "restrictionMessage": "string"
    }
  ]
}
 UserAccess

post

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

{
  "access": [
    {
      "crn": "string",
      "userExcluded": "boolean",
      "userRestricted": "boolean",
      "exclusionMessage": "string",
      "restrictionMessage": "string"
    }
  ]
}
 UserAccess

/probation-case/{crn}/referrals

put

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
204

No Content

/probation-case/{crn}/referrals/{referralId}/appointments

put

Parameters

ParameterInTypeRequiredDescription
crn path string true
referralId path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/users/{username}/managed-cases

get

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

{
  "managedCases": [
    {
      "crn": "string",
      "nomsId": "string"
    }
  ]
}
 ManagedCases

/users/{username}/details

get

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

{
  "username": "string",
  "name": {
    "forename": "string",
    "surname": "string"
  },
  "email": "string"
}
 UserDetail

/probation-delivery-units

get

Responses

StatusDescriptionSchema
200

OK

{
}

/probation-case/{crn}/responsible-officer

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "communityManager": {
    "code": "string",
    "name": {
      "forename": "string",
      "surname": "string"
    },
    "username": "string",
    "email": "string",
    "telephoneNumber": "string",
    "responsibleOfficer": "boolean",
    "pdu": {
      "code": "string",
      "description": "string"
    },
    "team": {
      "code": "string",
      "description": "string",
      "email": "string",
      "telephoneNumber": "string"
    },
    "officeLocations": [
      {
        "code": "string",
        "description": "string",
        "address": {
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string"
        },
        "telephoneNumber": "string",
        "provider": {
          "code": "string",
          "description": "string"
        }
      }
    ],
    "unallocated": "boolean"
  },
  "prisonManager": {
    "code": "string",
    "name": {
      "forename": "string",
      "surname": "string"
    },
    "username": "string",
    "email": "string",
    "telephoneNumber": "string",
    "responsibleOfficer": "boolean",
    "pdu": {
      "code": "string",
      "description": "string"
    },
    "team": {
      "code": "string",
      "description": "string",
      "email": "string",
      "telephoneNumber": "string"
    },
    "officeLocations": [
      {
        "code": "string",
        "description": "string",
        "address": {
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string"
        },
        "telephoneNumber": "string",
        "provider": {
          "code": "string",
          "description": "string"
        }
      }
    ],
    "unallocated": "boolean"
  }
}
 ResponsibleOfficer

/probation-case/{crn}/identifiers

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

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

/probation-case/{crn}/details

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "name": {
    "forename": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "gender": "string",
  "profile": {
    "primaryLanguage": "string",
    "ethnicity": "string",
    "religion": "string",
    "disabilities": [
      {
        "type": "string",
        "startDate": "string",
        "notes": "string"
      }
    ]
  },
  "contactDetails": {
    "noFixedAbode": "boolean",
    "mainAddress": {
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string"
    },
    "emailAddress": "string",
    "telephoneNumber": "string",
    "mobileNumber": "string"
  }
}
 CaseDetail

/probation-case/{crn}/convictions

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "caseDetail": {
    "crn": "string",
    "name": {
      "forename": "string",
      "surname": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "profile": {
      "primaryLanguage": "string",
      "ethnicity": "string",
      "religion": "string",
      "disabilities": [
        {
          "type": "string",
          "startDate": "string",
          "notes": "string"
        }
      ]
    },
    "contactDetails": {
      "noFixedAbode": "boolean",
      "mainAddress": {
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string"
      },
      "emailAddress": "string",
      "telephoneNumber": "string",
      "mobileNumber": "string"
    }
  },
  "convictions": [
    {
      "id": "integer",
      "date": "string",
      "sentence": {
        "description": "string",
        "expectedEndDate": "string"
      },
      "mainOffence": {
        "category": "string",
        "subCategory": "string"
      },
      "active": "boolean"
    }
  ]
}
 CaseConvictions

/probation-case/{crn}/convictions/{id}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true
id path integer true

Responses

StatusDescriptionSchema
200

OK

{
  "caseDetail": {
    "crn": "string",
    "name": {
      "forename": "string",
      "surname": "string"
    },
    "dateOfBirth": "string",
    "gender": "string",
    "profile": {
      "primaryLanguage": "string",
      "ethnicity": "string",
      "religion": "string",
      "disabilities": [
        {
          "type": "string",
          "startDate": "string",
          "notes": "string"
        }
      ]
    },
    "contactDetails": {
      "noFixedAbode": "boolean",
      "mainAddress": {
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string"
      },
      "emailAddress": "string",
      "telephoneNumber": "string",
      "mobileNumber": "string"
    }
  },
  "conviction": {
    "id": "integer",
    "date": "string",
    "sentence": {
      "description": "string",
      "expectedEndDate": "string"
    },
    "mainOffence": {
      "category": "string",
      "subCategory": "string"
    },
    "active": "boolean"
  }
}
 CaseConviction

/office-locations

get

Responses

StatusDescriptionSchema
200

OK

{
}

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

Schemas

CaseAccess

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

UserAccess

NameTypeRequiredDescriptionSchema
access array true CaseAccess

ReferralStarted

NameTypeRequiredDescriptionSchema
referralId string true
startedAt string true
contractType string true
sentenceId integer true
notes string true
urn string true

MergeAppointment

NameTypeRequiredDescriptionSchema
id string true
referralId string true
referralReference string true
start string true
durationInMinutes integer true
notes string false
officeLocationCode string false
countsTowardsRar boolean true
outcome object false Outcome
sentenceId integer false
previousId string false
deliusId integer false
rescheduleRequestedBy string false
end string true
typeCode string true
urn string true
previousUrn string false
referralUrn string true
rescheduleOutcome string true

Outcome

NameTypeRequiredDescriptionSchema
attended string true
didSessionHappen boolean false
noSessionReasonType string false
notify boolean true
sessionHappened boolean true

CaseIdentifier

NameTypeRequiredDescriptionSchema
crn string true
nomsId string false

ManagedCases

NameTypeRequiredDescriptionSchema
managedCases array true CaseIdentifier

Name

NameTypeRequiredDescriptionSchema
forename string true
surname string true

UserDetail

NameTypeRequiredDescriptionSchema
username string true
name object true Name
email string false

DeliveryUnit

NameTypeRequiredDescriptionSchema
code string true
description string true
region object true Region

Region

NameTypeRequiredDescriptionSchema
code string true
description string true

Address

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

Manager

NameTypeRequiredDescriptionSchema
code string true
name object true Name
username string false
email string false
telephoneNumber string false
responsibleOfficer boolean true
pdu object true Pdu
team object true Team
officeLocations array true OfficeLocation
unallocated boolean true

OfficeLocation

NameTypeRequiredDescriptionSchema
code string true
description string true
address object false Address
telephoneNumber string false
provider object true Provider

Pdu

NameTypeRequiredDescriptionSchema
code string true
description string true

Provider

NameTypeRequiredDescriptionSchema
code string true
description string true

ResponsibleOfficer

NameTypeRequiredDescriptionSchema
communityManager object true Manager
prisonManager object false Manager

Team

NameTypeRequiredDescriptionSchema
code string true
description string true
email string false
telephoneNumber string false

CaseDetail

NameTypeRequiredDescriptionSchema
crn string true
name object true Name
dateOfBirth string true
gender string false
profile object false Profile
contactDetails object true ContactDetails

ContactDetails

NameTypeRequiredDescriptionSchema
noFixedAbode boolean true
mainAddress object false Address
emailAddress string false
telephoneNumber string false
mobileNumber string false

Disability

NameTypeRequiredDescriptionSchema
type string true
startDate string true
notes string false

Profile

NameTypeRequiredDescriptionSchema
primaryLanguage string false
ethnicity string false
religion string false
disabilities array true Disability

CaseConvictions

NameTypeRequiredDescriptionSchema
caseDetail object true CaseDetail
convictions array true Conviction

Conviction

NameTypeRequiredDescriptionSchema
id integer true
date string false
sentence object true Sentence
mainOffence object true Offence
active boolean true

Offence

NameTypeRequiredDescriptionSchema
category string true
subCategory string true

Sentence

NameTypeRequiredDescriptionSchema
description string true
expectedEndDate string false

CaseConviction

NameTypeRequiredDescriptionSchema
caseDetail object true CaseDetail
conviction object true Conviction