application-lists

Create an Application List

Changed on

Creates a new Application List from the supplied request body.

post/application-lists

Request

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

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, seconds are optional.

descriptionstring required
status'OPEN' | 'CLOSED' required

Status of the Application List.

courtLocationCodestring

Code that identifies the Court Location.

otherLocationDescriptionstring

Free-text location if not using a standard court.

cjaCodestring

Criminal Justice Area code.

durationHoursinteger
durationMinutesinteger

Example request

{
  "date": "2025-09-17",
  "time": "10:30:00",
  "status": "OPEN",
  "courtLocationCode": "LOC123",
  "otherLocationDescription": "Temporary Courtroom at Town Hall",
  "cjaCode": "CJ"
}

Response

Application List created

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