HMhm-courts-and-tribunals-service
standard-applicants

Get a print-ready JSON payload for a Standard Applicants

Changed on

Returns all data required for printing Standard Applicants filtered by the supported print criteria; code, name, addressLine1, from and to. Dates are returned in ISO format; frontend PDF rendering should display dates as dd/MM/yyyy for legacy parity. Code and name are optional and may be combined; both must match when supplied together. Without date filters, only currently active records are returned, as for search. Returns all matching pages in the requested order (default code ascending). Results exceeding appreg.standard-applicants.max-print-rows (default 1000) are rejected with HTTP 400; results are never silently truncated.

get/standard-applicants/reports/print

Request

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

Query parameters

codestring

Filter by code.

namestring

Filter by applicant name.

fromstring date

Filter by from date.

tostring date

Filter by to date.

addressLine1string

Filter by address line 1.

sortstring[]

Sort parameter. Format property,(asc|desc).

Response

Print-ready Standard Applicants payload.

reportTitlestring required
generatedAtstring date-time required
recordCountinteger required

Example response

{
  "reportTitle": "Standard Applicants Report"
}

Changes

  • 45cc57050ecdRevision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property / from the response with the status

  • 8edc8f192ed9Revision changes
    • info

      endpoint added