HMhm-courts-and-tribunals-service
application-lists

Update an Application List

Changed on

Full replacement (PUT) of an existing Application List. The id is taken from the path; the request body must satisfy the same constraints as create (including the XOR location rule: either courtLocation or (otherLocationDescription + criminalJusticeAreaCode)). The request must include a valid If-Match header for optimistic concurrency control; a mismatch results in 409 Conflict.

put/application-lists/{listId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /application-lists/{listId}
  • Auth
    none declared

Path parameters

listIdstring uuid required

Public identifier of the Application List.

Request body

datestring date required

The calendar date on which the Application List is scheduled.

timestring time required

The time of day at which the Application List is scheduled.

descriptionstring required

Human-readable description of the Application List (e.g. session title or purpose).

status'OPEN' | 'CLOSED' required

Status of the Application List.

otherLocationDescriptionstring

Free-text location if not using a standard court.

courtLocationCodestring

Code that identifies the Court Location.

cjaCodestring

Criminal Justice Area code.

durationHoursinteger

Duration hours component.

durationMinutesinteger

Duration minutes component.

Example request

{
  "date": "2025-09-17",
  "time": "10:30:00",
  "description": "Morning session for traffic-related applications",
  "status": "OPEN",
  "otherLocationDescription": "Temporary Courtroom at Town Hall",
  "courtLocationCode": "LOC123",
  "cjaCode": "CJ",
  "durationHours": 2,
  "durationMinutes": 30
}

Response

Updated Application List

idstring uuid required

Unique identifier of the Application List.

datestring date required

The calendar date on which the Application List is scheduled.

timestring time required

The time of day at which the Application List is scheduled, seconds are optional.

descriptionstring required

Human-readable description of the Application List (e.g. session title or purpose).

status'OPEN' | 'CLOSED' required

Status of the Application List.

courtCodestring

Code that identifies the Court Location.

courtNamestring

Name that identifies the Court Location.

cjaCodestring

Criminal Justice Area code.

otherLocationDescriptionstring

Free-text location if not using a standard court.

durationHoursinteger

Duration hours component.

durationMinutesinteger

Duration minutes component.

versioninteger required

Current resource version for optimistic concurrency.

entriesCountinteger

Total number of Application List Entries associated with this Application List.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "date": "2025-09-17",
  "time": "10:30:00",
  "description": "Morning session for traffic-related applications",
  "status": "OPEN",
  "courtCode": "LOC123",
  "courtName": "Bath Magistrates Court",
  "cjaCode": "CJA001",
  "otherLocationDescription": "Temporary Courtroom at Town Hall",
  "durationHours": 2,
  "durationMinutes": 30,
  "version": 3,
  "entriesCount": 12
}

Changes