API Reference

The following documentation is also available in these formats:

API Reference v1.0

/users/{username}/roles/{role}

put

Parameters

Parameter

Type

Required

Description

username

path

string

true

role

path

string

true

Available items:

LHDCBT002
LHDCBT003

Responses

Status	Description	Schema
200	OK

delete

Parameters

Parameter

Type

Required

Description

username

path

string

true

role

path

string

true

Available items:

LHDCBT002
LHDCBT003

Responses

Status	Description	Schema
200	OK

/users/{username}/details

get

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "username": "string", "enabled": "boolean", "roles": [ { } ] }`	UserDetails

{
  "username": "string",
  "enabled": "boolean",
  "roles": [
    {
    }
  ]
}

UserDetails

/staff

get

Parameters

Parameter	In	Type	Required	Description
username	query	string	true
id	query	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "code": "string", "staffId": "integer", "name": { "forenames": "string", "surname": "string" }, "teams": [ { "code": "string", "description": "string", "telephone": "string", "emailAddress": "string", "probationDeliveryUnit": { "code": "string", "description": "string" }, "localAdminUnit": { "code": "string", "description": "string" } } ], "username": "string", "email": "string" }`	Staff

{
  "code": "string",
  "staffId": "integer",
  "name": {
    "forenames": "string",
    "surname": "string"
  },
  "teams": [
    {
      "code": "string",
      "description": "string",
      "telephone": "string",
      "emailAddress": "string",
      "probationDeliveryUnit": {
        "code": "string",
        "description": "string"
      },
      "localAdminUnit": {
        "code": "string",
        "description": "string"
      }
    }
  ],
  "username": "string",
  "email": "string"
}

Staff

/staff/{code}

get

Parameters

Parameter	In	Type	Required	Description
code	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "code": "string", "staffId": "integer", "name": { "forenames": "string", "surname": "string" }, "teams": [ { "code": "string", "description": "string", "telephone": "string", "emailAddress": "string", "probationDeliveryUnit": { "code": "string", "description": "string" }, "localAdminUnit": { "code": "string", "description": "string" } } ], "username": "string", "email": "string" }`	Staff

{
  "code": "string",
  "staffId": "integer",
  "name": {
    "forenames": "string",
    "surname": "string"
  },
  "teams": [
    {
      "code": "string",
      "description": "string",
      "telephone": "string",
      "emailAddress": "string",
      "probationDeliveryUnit": {
        "code": "string",
        "description": "string"
      },
      "localAdminUnit": {
        "code": "string",
        "description": "string"
      }
    }
  ],
  "username": "string",
  "email": "string"
}

Staff

/staff/{code}/managedPrisonerIds

get

Parameters

Parameter	In	Type	Required	Description
code	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/providers

get

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/providers/{providerCode}/localAdminUnits/{lauCode}

get

Parameters

Parameter	In	Type	Required	Description
providerCode	path	string	true
lauCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "code": "string", "description": "string", "teams": [ { "code": "string", "description": "string" } ] }`	LocalAdminUnitWithTeams

{
  "code": "string",
  "description": "string",
  "teams": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

LocalAdminUnitWithTeams

/providers/{code}

get

Parameters

Parameter	In	Type	Required	Description
code	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "code": "string", "description": "string", "localAdminUnits": [ { "code": "string", "description": "string" } ] }`	ProviderWithLaus

{
  "code": "string",
  "description": "string",
  "localAdminUnits": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

ProviderWithLaus

/managedPrisonerIds

get

Parameters

Parameter	In	Type	Required	Description
staffId	query	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/case/{nomsNumber}/communityManager

get

Parameters

Parameter	In	Type	Required	Description
nomsNumber	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "code": "string", "staffId": "integer", "name": { "forenames": "string", "surname": "string" }, "team": { "code": "string", "description": "string" }, "localAdminUnit": { "code": "string", "description": "string" }, "provider": { "code": "string", "description": "string" }, "isUnallocated": "boolean" }`	CommunityManager

{
  "code": "string",
  "staffId": "integer",
  "name": {
    "forenames": "string",
    "surname": "string"
  },
  "team": {
    "code": "string",
    "description": "string"
  },
  "localAdminUnit": {
    "code": "string",
    "description": "string"
  },
  "provider": {
    "code": "string",
    "description": "string"
  },
  "isUnallocated": "boolean"
}

CommunityManager

Schemas

UserDetails

Name	Type	Required
username	string	true
enabled	boolean	true
roles	array	true

LocalAdminUnit

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Name

Name	Type	Required	Description	Schema
forenames	string	true
surname	string	true

ProbationDeliveryUnit

Name	Type	Required	Description	Schema
code	string	true
description	string	true

Staff

Name	Type	Required	Schema
code	string	true
staffId	integer	true
name	object	true	Name
teams	array	true	TeamDetails
username	string	false
email	string	false

TeamDetails

Name	Type	Required	Schema
code	string	true
description	string	true
telephone	string	false
emailAddress	string	false
probationDeliveryUnit	object	true	ProbationDeliveryUnit
localAdminUnit	object	true	LocalAdminUnit

Provider

Name	Type	Required	Description	Schema
code	string	true
description	string	true

LocalAdminUnitWithTeams

Name	Type	Required	Schema
code	string	true
description	string	true
teams	array	true	Team

Team

Name	Type	Required	Description	Schema
code	string	true
description	string	true

ProviderWithLaus

Name	Type	Required	Schema
code	string	true
description	string	true
localAdminUnits	array	true	LocalAdminUnit

CommunityManager

Name	Type	Required	Schema
code	string	true
staffId	integer	true
name	object	true	Name
team	object	true	Team
localAdminUnit	object	true	LocalAdminUnit
provider	object	true	Provider
isUnallocated	boolean	true