API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/roles

put

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status	Description	Schema
200	OK

delete

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status	Description	Schema
200	OK

/staff

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/probation-case/responsible-community-manager

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

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

get

Parameters

Parameter	In	Type	Required	Description
teamCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/staff/{username}

get

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
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

{
  "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

Parameter	In	Type	Required	Description
staffCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/staff/{boroughCode}/pdu-head

get

Parameters

Parameter	In	Type	Required	Description
boroughCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/staff/byid/{id}

get

Parameters

Parameter	In	Type	Required	Description
id	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
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

{
  "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

Parameter	In	Type	Required	Description
id	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/staff/bycode/{code}

get

Parameters

Parameter	In	Type	Required	Description
code	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
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

{
  "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/{crn}/responsible-community-manager

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "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", "unallocated": "boolean" }	Manager

{
  "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",
  "unallocated": "boolean"
}

Manager

/docs/asyncapi

get

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

Schemas

Name

Name	Type	Required
forename	string	true
middleName	string	false
surname	string	true

StaffName

Name	Type	Required	Schema
id	integer	true
name	object	true	Name
code	string	true
username	string	false

StaffEmail

Name	Type	Required	Description	Schema
code	string	true
email	string	false

Borough

Name	Type	Required	Description	Schema
code	string	true
description	string	true

District

Name	Type	Required	Schema
code	string	true
description	string	true
borough	object	true	Borough

ManagedOffender

Name	Type	Required	Schema
crn	string	true
name	object	true	Name
allocationDate	string	false
staff	object	true	Staff
team	object	false	Team

OfficeAddress

Name	Type	Required
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

Provider

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Staff

Name	Type	Required	Schema
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

Name	Type	Required	Schema
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

PDUHead

Name	Type	Required	Description	Schema
name	object	true		Name
email	string	false

Manager

Name	Type	Required	Schema
id	integer	true
code	string	true
name	object	true	Name
provider	object	true	Provider
team	object	true	Team
username	string	false
email	string	false
unallocated	boolean	true