openapi: 3.2.0
info:
  title: Hmcts Application Lists API
  version: '@version@'
  contact:
    name: HMCTS AppReg Team
    url: https://github.com/hmcts/appreg-api
  description: 'Operations tagged application-lists across 2 of this provider''s published API definitions: appreg-api-openapi.yaml, hmcts-applications-register-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- description: An Application List records the date, time and location at which one or more Applications is to be considered by a magistrate or delegated authority.
  name: application-lists
paths:
  /application-lists:
    get:
      description: Returns a paginated list of Application Lists.
      operationId: getApplicationLists
      parameters:
      - description: Filter criteria for Application Lists.
        explode: true
        in: query
        name: filter
        required: false
        schema:
          $ref: '#/components/schemas/application-list-get-filter-dto'
        style: form
      - in: query
        name: pageNumber
        schema:
          default: 0
          minimum: 0
          type: integer
      - in: query
        name: pageSize
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: 'Sort parameter. Format: `property,(asc|desc)`. Currently only a single sort value is supported. Example: `?sort=date,desc`.

          '
        explode: true
        in: query
        name: sort
        schema:
          example:
          - date,desc
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/vnd.hmcts.appreg.v1+json:
              schema:
                $ref: '#/components/schemas/application-list-page'
          description: Page of Application Lists
          headers:
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '406':
          content:
            application/problem+json:
              examples:
                notAcceptable:
                  value:
                    type: https://errors.hmcts.net/common/not-acceptable
                    title: Not Acceptable
                    status: 406
                    detail: Requested media type/version not acceptable
              schema:
                $ref: '#/components/schemas/problem'
          description: Requested media type/version not acceptable.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Get Application Lists (paginated, filterable)
      tags:
      - application-lists
    post:
      description: Creates a new Application List from the supplied request body.
      operationId: createApplicationList
      requestBody:
        content:
          application/vnd.hmcts.appreg.v1+json:
            schema:
              $ref: '#/components/schemas/application-list-create-dto'
        required: true
      responses:
        '201':
          content:
            application/vnd.hmcts.appreg.v1+json:
              schema:
                $ref: '#/components/schemas/application-list-get-detail-dto'
          description: Application List created
          headers:
            Location:
              description: URL of the created Application List
              schema:
                type: string
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Create an Application List
      tags:
      - application-lists
    servers:
    - url: /
  /application-lists/print:
    post:
      description: Returns print-oriented Application Lists for one or more Application Lists in a single request. Supply `listIds` to scope the search. If `entryIds` is omitted or empty, all active entries from the supplied lists are returned. If `entryIds` is supplied, only the specified active entries from the supplied lists are returned within each returned list. Validation is all-or-nothing.
      operationId: printApplicationLists
      requestBody:
        content:
          application/vnd.hmcts.appreg.v1+json:
            schema:
              $ref: '#/components/schemas/bulk-get-application-list-entries-request-dto'
        required: true
      responses:
        '200':
          content:
            application/vnd.hmcts.appreg.v1+json:
              schema:
                items:
                  $ref: '#/components/schemas/application-list-get-print-dto'
                type: array
          description: Matching print-ready Application Lists in input order.
          headers:
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '404':
          content:
            application/problem+json:
              examples:
                missing:
                  value:
                    type: https://errors.hmcts.net/appreg/not-found
                    title: Not Found
                    status: 404
                    detail: Result code with id=123 was not found
              schema:
                $ref: '#/components/schemas/problem'
          description: The requested resource was not found.
        '406':
          content:
            application/problem+json:
              examples:
                notAcceptable:
                  value:
                    type: https://errors.hmcts.net/common/not-acceptable
                    title: Not Acceptable
                    status: 406
                    detail: Requested media type/version not acceptable
              schema:
                $ref: '#/components/schemas/problem'
          description: Requested media type/version not acceptable.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Get print-ready Application Lists in bulk
      tags:
      - application-lists
    servers:
    - url: /
  /application-lists/{listId}:
    delete:
      description: Permanently deletes the Application List identified by `listId`.
      operationId: deleteApplicationList
      parameters:
      - description: Public identifier of the Application List.
        example: 123e4567-e89b-12d3-a456-426655440000
        in: path
        name: listId
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          description: Application List deleted (no content)
          headers:
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '404':
          content:
            application/problem+json:
              examples:
                missing:
                  value:
                    type: https://errors.hmcts.net/appreg/not-found
                    title: Not Found
                    status: 404
                    detail: Result code with id=123 was not found
              schema:
                $ref: '#/components/schemas/problem'
          description: The requested resource was not found.
        '409':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/conflict
                    title: Conflict
                    status: 409
                    detail: The Application List could not be modified due to a conflict with its current state
              schema:
                $ref: '#/components/schemas/problem'
          description: Conflict with the current state of the resource.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Delete an Application List
      tags:
      - application-lists
    get:
      description: Returns the Application List identified by `listId`.
      operationId: getApplicationList
      parameters:
      - description: Public identifier of the Application List.
        example: 123e4567-e89b-12d3-a456-426655440000
        in: path
        name: listId
        required: true
        schema:
          format: uuid
          type: string
      - description: Zero-based page index.
        in: query
        name: pageNumber
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
      - description: Page size.
        in: query
        name: pageSize
        schema:
          default: 10
          format: int32
          maximum: 100
          minimum: 1
          type: integer
      - description: 'Sort parameter. Format: `property,(asc|desc)`. Currently only a single sort value is supported. Example: `?sort=name,asc`.

          '
        explode: true
        in: query
        name: sort
        schema:
          example:
          - name,asc
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/vnd.hmcts.appreg.v1+json:
              schema:
                $ref: '#/components/schemas/application-list-get-detail-dto'
          description: Application List detail
          headers:
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '404':
          content:
            application/problem+json:
              examples:
                missing:
                  value:
                    type: https://errors.hmcts.net/appreg/not-found
                    title: Not Found
                    status: 404
                    detail: Result code with id=123 was not found
              schema:
                $ref: '#/components/schemas/problem'
          description: The requested resource was not found.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Get an Application List by id
      tags:
      - application-lists
    put:
      description: '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.'
      operationId: updateApplicationList
      parameters:
      - description: Public identifier of the Application List.
        example: 123e4567-e89b-12d3-a456-426655440000
        in: path
        name: listId
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/vnd.hmcts.appreg.v1+json:
            schema:
              $ref: '#/components/schemas/application-list-update-dto'
        required: true
      responses:
        '200':
          content:
            application/vnd.hmcts.appreg.v1+json:
              schema:
                $ref: '#/components/schemas/application-list-get-detail-dto'
          description: Updated Application List
          headers:
            Vary:
              description: Response varies by Accept for media-type versioning.
              schema:
                example: Accept
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
          description: Invalid request parameters.
        '401':
          content:
            application/problem+json:
              examples:
                unauthenticated:
                  value:
                    type: https://errors.hmcts.net/common/unauthorized
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid credentials
              schema:
                $ref: '#/components/schemas/problem'
          description: Authentication required or token invalid.
        '403':
          content:
            application/problem+json:
              examples:
                forbidden:
                  value:
                    type: https://errors.hmcts.net/common/forbidden
                    title: Forbidden
                    status: 403
                    detail: You do not have permission to access this resource
              schema:
                $ref: '#/components/schemas/problem'
          description: Authenticated but not permitted to perform this action.
        '404':
          content:
            application/problem+json:
              examples:
                missing:
                  value:
                    type: https://errors.hmcts.net/appreg/not-found
                    title: Not Found
                    status: 404
                    detail: Result code with id=123 was not found
              schema:
                $ref: '#/components/schemas/problem'
          description: The requested resource was not found.
        '409':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/conflict
                    title: Conflict
                    status: 409
                    detail: The Application List could not be modified due to a conflict with its current state
              schema:
                $ref: '#/components/schemas/problem'
          description: Conflict with the current state of the resource.
        '500':
          content:
            application/problem+json:
              examples:
                generic:
                  value:
                    type: https://errors.hmcts.net/common/internal-error
                    title: Internal Server Error
                    status: 500
                    detail: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/problem'
          description: Unexpected server error.
      summary: Update an Application List
      tags:
      - application-lists
    servers:
    - url: /
components:
  schemas:
    applicant:
      additionalProperties: false
      description: 'The applicant making the application.

        In application read and print responses, Standard Applicants are represented by their

        reference name in organisation.name (or their code when no reference name exists).

        Their personal and contact values are not returned. For these read responses the

        shared input contact constraints do not apply: contact fields may be null or absent.

        Ordinary applicant input still requires the person or organisation contact details.

        '
      properties:
        person:
          $ref: '#/components/schemas/person'
        organisation:
          $ref: '#/components/schemas/organisation'
      type: object
    application-list-update-dto:
      additionalProperties: false
      description: Request payload to fully replace an existing Application List. Blank fields will be rejected, nulls should be used instead.
      properties:
        date:
          description: The calendar date on which the Application List is scheduled.
          example: 2025-09-17
          format: date
          type: string
        time:
          description: The time of day at which the Application List is scheduled.
          example: 37800
          format: time
          type: string
        description:
          description: Human-readable description of the Application List (e.g. session title or purpose).
          example: Morning session for traffic-related applications
          maxLength: 200
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/application-list-status'
        otherLocationDescription:
          description: Free-text location if not using a standard court.
          example: Temporary Courtroom at Town Hall
          maxLength: 200
          minLength: 1
          type: string
        courtLocationCode:
          description: Code that identifies the Court Location.
          example: LOC123
          maxLength: 10
          minLength: 1
          type: string
        cjaCode:
          description: Criminal Justice Area code.
          example: CJ
          maxLength: 2
          minLength: 1
          type: string
        durationHours:
          description: Duration hours component.
          example: 2
          format: int32
          maximum: 99
          minimum: 0
          type: integer
        durationMinutes:
          description: Duration minutes component.
          example: 30
          format: int32
          maximum: 59
          minimum: 0
          type: integer
      required:
      - date
      - description
      - status
      - time
      type: object
    entry-get-print-dto:
      description: An application view, used specifically for printing.
      properties:
        id:
          description: Unique identifier of the Application List Entry.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          format: uuid
          type: string
        applicant:
          $ref: '#/components/schemas/applicant'
        respondent:
          $ref: '#/components/schemas/respondent'
        applicationCode:
          description: Code that identifies the application.
          example: AD99001
          type: string
        applicationTitle:
          description: The title of the application.
          example: Appeal to Crown Court
          type: string
        applicationWording:
          description: Full description of the application.
          example: Notice of appeal in respect of a case heard on 10-01-2026
          type: string
        resultWordings:
          description: A list of result wordings for the application.
          example:
          - Appeal forwarded to Bristol Crown Court.
          - Respondent Attended.
          items:
            type: string
          type: array
        officials:
          description: A list of officials that ruled on the application.
          items:
            $ref: '#/components/schemas/official'
          type: array
        caseReference:
          description: A reference code to identify a related case (maximum 15 characters).
          example: CASE-001
          maxLength: 15
          type: string
        accountReference:
          description: The Applicants account number (maximum 20 characters).
          example: CCC-001
          maxLength: 20
          type: string
        notes:
          description: Notes about the application or the hearing (maximum 4000 characters).
          example: Time is 10:31, we have convened to talk about Application...
          maxLength: 4000
          type: string
      required:
      - applicant
      - applicationCode
      - applicationTitle
      - applicationWording
      - id
      type: object
    application-list-get-summary-dto:
      description: Lightweight DTO for Application Lists, used in list/search views.
      properties:
        id:
          description: Unique identifier of the Application List.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          format: uuid
          type: string
        date:
          description: The calendar date on which the Application List is scheduled.
          example: 2025-09-17
          format: date
          type: string
        time:
          description: The time of day at which the Application List is scheduled, seconds are optional.
          example: 37800
          format: time
          type: string
        location:
          description: Location where the applications will be considered.
          example: Bath Magistrates Court
          type: string
        description:
          description: Human-readable description of the Application List (e.g. session title or purpose).
          example: Morning session for traffic-related applications
          type: string
        entriesCount:
          description: Total number of Application List Entries associated with this Application List.
          example: 12
          format: int32
          type: integer
        status:
          $ref: '#/components/schemas/application-list-status'
      required:
      - date
      - description
      - id
      - location
      - numberOfEntries
      - status
      - time
      type: object
    application-list-page:
      allOf:
      - $ref: '#/components/schemas/page'
      - properties:
          content:
            items:
              $ref: '#/components/schemas/application-list-get-summary-dto'
            type: array
        type: object
    sort_orders_inner:
      properties:
        property:
          description: Property name used for sorting.
          example: title
          type: string
        direction:
          description: Sort direction.
          enum:
          - asc
          - desc
          example: asc
          type: string
      required:
      - direction
      - property
      type: object
    problem:
      description: RFC 9457/7807 problem details.
      properties:
        type:
          description: Problem type identifier (URI).
          example: https://errors.hmcts.net/appreg/bad-request
          format: uri
          type: string
        title:
          description: Short, human-readable summary.
          example: Invalid request parameters
          type: string
        status:
          description: HTTP status code.
          example: 400
          format: int32
          type: integer
        detail:
          description: Human-readable explanation specific to this occurrence.
          example: startDateFrom must be on or before startDateTo
          type: string
        instance:
          description: URI reference to the specific occurrence (if applicable).
          example: urn:request:2f9c3d8a-1b3a-4a1e-9b7f-6b2a6a0a2b2f
          format: uri
          type: string
        correlationId:
          description: Server-side correlation ID for tracing.
          example: 3e1a2c95a7d84a5fb3e1a2c95a7d84a5
          type: string
      required:
      - status
      - title
      - type
      type: object
    organisation:
      additionalProperties: false
      description: The organisation making, or responding to, the application. Blank fields will be rejected, nulls should be used instead.
      properties:
        name:
          description: The name of the organisation.
          example: ACME Industries LTD
          maxLength: 100
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type: string
        contactDetails:
          $ref: '#/components/schemas/contact-details'
      required:
      - contactDetails
      - name
      type: object
    official-type:
      description: The type of Official hearing the application.
      enum:
      - MAGISTRATE
      - CLERK
      example: MAGISTRATE
      type: string
    application-list-create-dto:
      additionalProperties: false
      description: Request payload to create an Application List. Blank fields will be rejected, nulls should be used instead.
      properties:
        date:
          description: The calendar date on which the Application List is scheduled.
          example: 2025-09-17
          format: date
          type: string
        time:
          description: The time of day at which the Application List is scheduled, seconds are optional.
          example: 37800
          format: time
          type: string
        description:
          maxLength: 200
          minLength: 1
          type: string
        status:
          $ref: '#/components/schemas/application-list-status'
        courtLocationCode:
          description: Code that identifies the Court Location.
          example: LOC123
          maxLength: 10
          minLength: 1
          type: string
        otherLocationDescription:
          description: Free-text location if not using a standard court.
          example: Temporary Courtroom at Town Hall
          maxLength: 200
          minLength: 1
          type: string
        cjaCode:
          description: Criminal Justice Area code.
          example: CJ
          maxLength: 2
          minLength: 1
          type: string
        durationHours:
          format: int32
          maximum: 99
          minimum: 0
          type: integer
        durationMinutes:
          format: int32
          maximum: 59
          minimum: 0
          type: integer
      required:
      - date
      - description
      - status
      - time
      type: object
    application-list-get-print-dto:
      description: Immutable DTO representing a detailed Application List.
      properties:
        date:
          description: The calendar date on which the Application List is scheduled.
          example: 2025-09-17
          format: date
          type: string
        time:
          description: The time of day at which the Application List is scheduled, seconds are optional.
          example: 37800
          format: time
          type: string
        courtName:
          description: Name that identifies the Court Location.
          example: Bath Magistrates Court
          type: string
        cja:
          description: The Criminal Justice Area code and description.
          example: 52 - Avon & Somerset
          type: string
        otherLocationDescription:
          description: Free-text location if not using a standard court.
          example: Temporary Courtroom at Town Hall
          type: string
        duration:
          description: The length of the hearing that heard the Application List.
          example: 1 hour, 30 minutes
          type: string
        entries:
          description: List of entries (empty when none).
          items:
            $ref: '#/components/schemas/entry-get-print-dto'
          type: array
      required:
      - date
      - entries
      - time
      type: object
    page:
      description: Generic Spring Data page.
      properties:
        pageNumber:
          description: Zero-based page index.
          format: int32
          type: integer
        pageSize:
          description: Page size.
          format: int32
          type: integer
        totalElements:
          description: Total number of elements across all pages.
          format: int64
          type: integer
        totalPages:
          description: Total number of pages.
          format: int32
          type: integer
        sort:
          $ref: '#/components/schemas/sort'
        first:
          type: boolean
        last:
          type: boolean
        elementsOnPage:
          description: Total number of elements in the current page.
          format: int32
          type: integer
      required:
      - content
      - elementsOnPage
      - pageNumber
      - pageSize
      - totalElements
      type: object
    application-list-get-detail-dto:
      description: Immutable DTO representing a detailed Application List.
      properties:
        id:
          description: Unique identifier of the Application List.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          format: uuid
          type: string
        date:
          description: The calendar date on which the Application List is scheduled.
          example: 2025-09-17
          format: date
          type: string
        time:
          description: The time of day at which the Application List is scheduled, seconds are optional.
          example: 37800
          format: time
          type: string
        description:
          description: Human-readable description of the Application List (e.g. session title or purpose).
          example: Morning session for traffic-related applications
          type: string
        status:
          $ref: '#/components/schemas/application-list-status'
        courtCode:
          description: Code that identifies the Court Location.
          example: LOC123
          type: string
        courtName:
          description: Name that identifies the Court Location.
          example: Bath Magistrates Court
          type: string
        cjaCode:
          description: Criminal Justice Area code.
          example: CJA001
          type: string
        otherLocationDescription:
          description: Free-text location if not using a standard court.
          example: Temporary Courtroom at Town Hall
          type: string
        durationHours:
          description: Duration hours component.
          example: 2
          format: int32
          maximum: 99
          minimum: 0
          type: integer
        durationMinutes:
          description: Duration minutes component.
          example: 30
          format: int32
          maximum: 59
          minimum: 0
          type: integer
        version:
          description: Current resource version for optimistic concurrency.
          example: 3
          format: int64
          type: integer
        entriesCount:
          description: Total number of Application List Entries associated with this Application List.
          example: 12
          format: int32
          minimum: 0
          type: integer
      required:
      - date
      - description
      - id
      - status
      - time
      - version
      type: object
    contact-details:
      additionalProperties: false
      description: A participant's contact details. Blank fields will be rejected, nulls should be used instead.
      properties:
        addressLine1:
          description: Line one of the participant's address.
          example: 10 Downing Street
          maxLength: 35
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type: string
        addressLine2:
          description: Line two of the participant's address.
          example: Westminster
          maxLength: 35
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type:
          - string
          - 'null'
        addressLine3:
          description: Line three of the participant's address.
          example: London
          maxLength: 35
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type:
          - string
          - 'null'
        addressLine4:
          description: Line four of the participant's address.
          example: Greater London
          maxLength: 35
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type:
          - string
          - 'null'
        addressLine5:
          description: Line five of the participant's address.
          example: United Kingdom
          maxLength: 35
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type:
          - string
          - 'null'
        postcode:
          description: The participant's postcode.
          example: SW1A 2AA
          maxLength: 8
          minLength: 1
          pattern: ^(([A-Z]{1,2}((\d[A-Z\d])|(\d)) \d[A-Z]{2})|(GIR 0A{2}))$
          type: string
        phone:
          description: The participant's home-phone number.
          example: 01225 123456
          maxLength: 20
          minLength: 10
          pattern: '[0-9 \-]*'
          type:
          - string
          - 'null'
        mobile:
          description: The participant's mobile number.
          example: 07123456789
          maxLength: 20
          minLength: 11
          pattern: ^(?:\+\d{1,4}\s*)?[0-9 \-]*$
          type:
          - string
          - 'null'
        email:
          description: The participant's email address.
          example: john-doe@gmail.com
          maxLength: 253
          minLength: 1
          pattern: ^((([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,})))*$
          type:
          - string
          - 'null'
      required:
      - addressLine1
      type: object
    respondent_person:
      allOf:
      - $ref: '#/components/schemas/person'
      - description: Person details for a respondent (includes DOB).
        properties:
          dateOfBirth:
            description: Date of birth (only applicable for person respondents).
            example: 1990-01-01
            format: date
            type: string
        type: object
    application-list-status:
      description: Status of the Application List.
      enum:
      - OPEN
      - CLOSED
      example: OPEN
      type: string
    full-name:
      additionalProperties: false
      description: A persons full name. Blank fields will be rejected, nulls should be used instead.
      properties:
        title:
          description: Prefix before a persons name.
          example: Mr, Mrs
          maxLength: 100
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type: string
        firstName:
          description: The person's first name.
          example: John
          maxLength: 100
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type: string
        middleName:
          description: The person's optional middle name or names.
          example: James
          maxLength: 100
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type:
          - string
          - 'null'
        lastName:
          description: The person's family name.
          example: Smith
          maxLength: 100
          minLength: 1
          pattern: ^[^\u0000-\u001F\u007F-\u009F]*$
          type: string
      required:
      - firstName
      - lastName
      type: object
    respondent:
      additionalProperties: false
      description: The respondent to the application.
      properties:
        person:
          $ref: '#/components/schemas/respondent_person'
        organisation:
          $ref: '#/components/schemas/organisation'
      type: object
    sort:
      description: Sorting state for the returned page.
      example:
        orders:
        - property: title
          direction: asc
        - property: code
          direction: desc
      properties:
        orders:
          description: Active sort orders in priority order.
          items:
            $ref: '#/components/schemas/sort_orders_inner'
          type: array
      type: object
    official:
      additionalProperties: false
      description: The Official hearing the application. Blank fields will be rejected, nulls should be used instead.
      properties:
        title:
          description: Prefix before a persons name.
          example: Mr, Mrs
          maxLength: 100
          minLength: 1
          type: string
        surname:
          description: The persons family name.
          example: Smith
          maxLength: 100
          minLength: 1
          type: string
        forename:
          description: The persons first name.
          example: John
          maxLength: 100
          minLength: 1
          type: string
        type:
          $ref: '#/components/schemas/official-type'
      type: object
    application-list-get-filter-dto:
      description: Filter criteria for GET /application-lists.
      properties:
        date:
          description: Single date of the Application List.
          example: 2025-10-07
          format: date
          type: string
        time:
          description: Single time of the Application List.
          example: 37800
          format: time
          type: string
        courtLocationCode:
          description: Court Location code (exact match).
          example: LOC123
          maxLength: 10
          type: string
        cjaCode:
          description: CJA code (exact match).
          example: '52'
          maxLength: 2
          type: string
        description:
          description: Case-insensitive contains match on description.
          example: morning session
          maxLength: 200
          type: string
        otherLocationDescription:
          description: Case-insensitive contains match on other location description.
          example: town hall
          maxLength: 200
          type: string
        status:
          $ref: '#/components/schemas/application-list-status'
        hasEntries:
          description: 'Filters lists by active entries: true returns lists with at least one entry; false returns lists with no active entries.

            '
          example: true
          type: boolean
      type: object
    bulk-get-application-list-entries-request-dto:
      properties:
        listIds:
          description: 'Public identifiers of the Application Lists to read from. Must be non-empty, contain no duplicates, and contain at most 2000 items. Response order follows the supplied `listIds` order when `entryIds` is omitted or empty.

            '
          example:
          - 123e4567-e89b-12d3-a456-426655440000
          - 123e4567-e89b-12d3-a456-426655440001
          items:
            format: uuid
            type: string
          type: array
        entryIds:
          description: 'Optional public identifiers of specific Application List Entries to return. If omitted or empty, all active entries from the supplied `listIds` are returned. If supplied, the response follows the supplied `entryIds` order. Duplicates are rejected.

            '
          example:
          - 123e4567-e89b-12d3-a456-426655440100
          - 123e4567-e89b-12d3-a456-426655440101
          items:
            format: uuid
            type: string
          type: array
      required:
      - listIds
      type: object
    person:
      additionalProperties: false
      description: The person making, or responding to, the application.
      properties:
        name:
          $ref: '#/components/schemas/full-name'
        contactDetails:
          $ref: '#/components/schemas/contact-details'
      required:
      - contactDetails
      - name
      type: object
x-refined-from:
- appreg-api-openapi.yaml
- hmcts-applications-register-openapi.yml