Sign in

v5

latestOpenAPI 3.0.1raw.githubusercontent.com2026-05-207720.6 KB
Single Offender

Update the Complexity of Need level for an offender

Clients calling this endpoint must have role: ROLE_UPDATE_COMPLEXITY_OF_NEED

post/v1/complexity-of-need/offender-no/{offender_no}

Request body

level'low' | 'medium' | 'high' required

Complexity of Need Level

sourceUserstring

The NOMIS username that supplied this Complexity of Need entry

notesstring

Free-text notes for this entry

Example request

{
  "level": "low",
  "sourceUser": "JSMITH_GEN"
}

Response

Complexity of Need level set successfully

offenderNostring required

NOMIS Offender Number

level'low' | 'medium' | 'high' required

Complexity of Need Level

sourceUserstring

The NOMIS username that supplied this Complexity of Need entry

sourceSystemstring required

The OAuth Client ID of the system that created this entry

notesstring

Free-text notes for this entry

createdTimeStampstring date_time required

The date & time this entry was created (in RFC 3339 format)

updatedTimeStampstring date_time required

The date & time this entry was updated (in RFC 3339 format)

activeboolean required

Whether it is active or not

Example response

{
  "offenderNo": "A0000AA",
  "level": "low",
  "sourceUser": "JSMITH_GEN",
  "sourceSystem": "hmpps-api-client-id",
  "createdTimeStamp": "2021-03-02T17:18:46.457Z",
  "updatedTimeStamp": "2021-03-02T17:18:46.457Z"
}