Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/roles

put

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

delete

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

/staff

post

Responses

StatusDescriptionSchema
200

OK

{
}

/staff/byid/{id}/caseload/team-managed-offenders

post

Parameters

ParameterInTypeRequiredDescription
id path integer true
page query object true

Responses

StatusDescriptionSchema
200

OK

{
  "content": [
    {
      "crn": "string",
      "nomisId": "string",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "allocationDate": "string",
      "staff": {
        "id": "integer",
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "teams": [
          {
            "code": "string",
            "description": "string",
            "telephone": "string",
            "emailAddress": "string",
            "addresses": [
              {
                "officeName": "string",
                "buildingName": "string",
                "buildingNumber": "string",
                "streetName": "string",
                "district": "string",
                "town": "string",
                "county": "string",
                "postcode": "string",
                "ldu": "string",
                "telephoneNumber": "string",
                "from": "string",
                "to": "string"
              }
            ],
            "district": {
              "code": "string",
              "description": "string",
              "borough": {
                "code": "string",
                "description": "string"
              }
            },
            "borough": {
              "code": "string",
              "description": "string"
            },
            "startDate": "string",
            "endDate": "string"
          }
        ],
        "provider": {
          "code": "string",
          "description": "string"
        },
        "username": "string",
        "email": "string",
        "telephoneNumber": "string",
        "unallocated": "boolean"
      },
      "team": {
        "code": "string",
        "description": "string",
        "telephone": "string",
        "emailAddress": "string",
        "addresses": [
          {
            "officeName": "string",
            "buildingName": "string",
            "buildingNumber": "string",
            "streetName": "string",
            "district": "string",
            "town": "string",
            "county": "string",
            "postcode": "string",
            "ldu": "string",
            "telephoneNumber": "string",
            "from": "string",
            "to": "string"
          }
        ],
        "district": {
          "code": "string",
          "description": "string",
          "borough": {
            "code": "string",
            "description": "string"
          }
        },
        "borough": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string",
        "endDate": "string"
      }
    }
  ],
  "page": {
    "size": "integer",
    "number": "integer",
    "totalElements": "integer",
    "totalPages": "integer"
  }
}
 PagedModelManagedOffender

/probation-case

post

Responses

StatusDescriptionSchema
200

OK

{
}

/probation-case/responsible-community-manager

post

Responses

StatusDescriptionSchema
200

OK

{
}

/team/{teamCode}/caseload/managed-offenders

get

Parameters

ParameterInTypeRequiredDescription
teamCode path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/staff/{username}

get

Parameters

ParameterInTypeRequiredDescription
username path string true

Responses

StatusDescriptionSchema
200

OK

{
  "id": "integer",
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "teams": [
    {
      "code": "string",
      "description": "string",
      "telephone": "string",
      "emailAddress": "string",
      "addresses": [
        {
          "officeName": "string",
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string",
          "ldu": "string",
          "telephoneNumber": "string",
          "from": "string",
          "to": "string"
        }
      ],
      "district": {
        "code": "string",
        "description": "string",
        "borough": {
          "code": "string",
          "description": "string"
        }
      },
      "borough": {
        "code": "string",
        "description": "string"
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "provider": {
    "code": "string",
    "description": "string"
  },
  "username": "string",
  "email": "string",
  "telephoneNumber": "string",
  "unallocated": "boolean"
}
 Staff

/staff/{staffCode}/caseload/managed-offenders

get

Parameters

ParameterInTypeRequiredDescription
staffCode path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/staff/{boroughCode}/pdu-head

get

Parameters

ParameterInTypeRequiredDescription
boroughCode path string true

Responses

StatusDescriptionSchema
200

OK

{
}

/staff/byid/{id}

get

Parameters

ParameterInTypeRequiredDescription
id path integer true

Responses

StatusDescriptionSchema
200

OK

{
  "id": "integer",
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "teams": [
    {
      "code": "string",
      "description": "string",
      "telephone": "string",
      "emailAddress": "string",
      "addresses": [
        {
          "officeName": "string",
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string",
          "ldu": "string",
          "telephoneNumber": "string",
          "from": "string",
          "to": "string"
        }
      ],
      "district": {
        "code": "string",
        "description": "string",
        "borough": {
          "code": "string",
          "description": "string"
        }
      },
      "borough": {
        "code": "string",
        "description": "string"
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "provider": {
    "code": "string",
    "description": "string"
  },
  "username": "string",
  "email": "string",
  "telephoneNumber": "string",
  "unallocated": "boolean"
}
 Staff

/staff/byid/{id}/caseload/managed-offenders

get

Parameters

ParameterInTypeRequiredDescription
id path integer true

Responses

StatusDescriptionSchema
200

OK

{
}

/staff/bycode/{code}

get

Parameters

ParameterInTypeRequiredDescription
code path string true

Responses

StatusDescriptionSchema
200

OK

{
  "id": "integer",
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "teams": [
    {
      "code": "string",
      "description": "string",
      "telephone": "string",
      "emailAddress": "string",
      "addresses": [
        {
          "officeName": "string",
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string",
          "ldu": "string",
          "telephoneNumber": "string",
          "from": "string",
          "to": "string"
        }
      ],
      "district": {
        "code": "string",
        "description": "string",
        "borough": {
          "code": "string",
          "description": "string"
        }
      },
      "borough": {
        "code": "string",
        "description": "string"
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "provider": {
    "code": "string",
    "description": "string"
  },
  "username": "string",
  "email": "string",
  "telephoneNumber": "string",
  "unallocated": "boolean"
}
 Staff

/probation-case/{crnOrNomisId}

get

Parameters

ParameterInTypeRequiredDescription
crnOrNomisId path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "nomisId": "string",
  "pncNumber": "string",
  "croNumber": "string"
}
 ProbationCase

/probation-case/{crnOrNomisId}/responsible-community-manager

get

Parameters

ParameterInTypeRequiredDescription
crnOrNomisId path string true

Responses

StatusDescriptionSchema
200

OK

{
  "case": {
    "crn": "string",
    "nomisId": "string",
    "pncNumber": "string",
    "croNumber": "string"
  },
  "id": "integer",
  "code": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "provider": {
    "code": "string",
    "description": "string"
  },
  "team": {
    "code": "string",
    "description": "string",
    "telephone": "string",
    "emailAddress": "string",
    "addresses": [
      {
        "officeName": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "ldu": "string",
        "telephoneNumber": "string",
        "from": "string",
        "to": "string"
      }
    ],
    "district": {
      "code": "string",
      "description": "string",
      "borough": {
        "code": "string",
        "description": "string"
      }
    },
    "borough": {
      "code": "string",
      "description": "string"
    },
    "startDate": "string",
    "endDate": "string"
  },
  "username": "string",
  "email": "string",
  "telephoneNumber": "string",
  "allocationDate": "string",
  "unallocated": "boolean"
}
 Manager

/docs/asyncapi

get

Responses

StatusDescriptionSchema
200

OK

{
}

Schemas

Name

NameTypeRequiredDescriptionSchema
forename string true
middleName string false
surname string true

StaffName

NameTypeRequiredDescriptionSchema
id integer true
name object true Name
code string true
username string false

SearchRequest

NameTypeRequiredDescriptionSchema
query string false

Pageable

NameTypeRequiredDescriptionSchema
page integer false
size integer false
sort array false

Borough

NameTypeRequiredDescriptionSchema
code string true
description string true

District

NameTypeRequiredDescriptionSchema
code string true
description string true
borough object true Borough

ManagedOffender

NameTypeRequiredDescriptionSchema
crn string true
nomisId string false
name object true Name
allocationDate string false
staff object true Staff
team object false Team

OfficeAddress

NameTypeRequiredDescriptionSchema
officeName string true
buildingName string false
buildingNumber string false
streetName string false
district string false
town string false
county string false
postcode string false
ldu string true
telephoneNumber string false
from string true
to string false

PageMetadata

NameTypeRequiredDescriptionSchema
size integer false
number integer false
totalElements integer false
totalPages integer false

PagedModelManagedOffender

NameTypeRequiredDescriptionSchema
content array false ManagedOffender
page object false PageMetadata

Provider

NameTypeRequiredDescriptionSchema
code string true
description string true

Staff

NameTypeRequiredDescriptionSchema
id integer true
code string true
name object true Name
teams array true Team
provider object true Provider
username string false
email string false
telephoneNumber string false
unallocated boolean true

Team

NameTypeRequiredDescriptionSchema
code string true
description string true
telephone string false
emailAddress string false
addresses array false OfficeAddress
district object true District
borough object true Borough
startDate string true
endDate string false

ProbationCase

NameTypeRequiredDescriptionSchema
crn string true
nomisId string false
pncNumber string false
croNumber string false

Manager

NameTypeRequiredDescriptionSchema
case object true ProbationCase
id integer true
code string true
name object true Name
provider object true Provider
team object true Team
username string false
email string false
telephoneNumber string false
allocationDate string false
unallocated boolean true

PDUHead

NameTypeRequiredDescriptionSchema
name object true Name
email string false