HMhm-courts-and-tribunals-service
application-codes

Get Application Codes (paginated, filterable)

Changed on

Returns a paginated list of Application Codes.

  • Filters:
    • code – case-insensitive partial match
    • title – case-insensitive partial match
get/application-codes

Request

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

Query parameters

codestring

Filter by code (contains, case-insensitive).

titlestring

Filter by title (contains, case-insensitive).

datestring date

ISO date (yyyy-MM-dd) on which returned Application Codes must be valid.

pageNumberinteger

Zero-based page index.

pageSizeinteger

Page size.

sortstring[]

Sort parameter. Format: property,(asc|desc). Currently only a single sort value is supported. Example: ?sort=title,asc. Supported properties:

  • title
  • code
  • bulkRespondentAllowed
  • feeDue
[
  "title,asc"
]

Response

Page of Application Codes

pageNumberinteger required

Zero-based page index.

pageSizeinteger required

Page size.

totalElementsinteger required

Total number of elements across all pages.

totalPagesinteger

Total number of pages.

firstboolean
lastboolean
elementsOnPageinteger required

Total number of elements in the current page.

Example response

{
  "sort": {
    "orders": [
      {
        "property": "title",
        "direction": "asc"
      },
      {
        "property": "code",
        "direction": "desc"
      }
    ]
  },
  "content": [
    {
      "applicationCode": "AD99003",
      "wording": {
        "template": "This is a test {{Applicant number}} with a date",
        "substitution-key-constraints": [
          {
            "key": "account-number",
            "value": "12345678",
            "constraint": {
              "type": "TEXT",
              "length": 1234
            }
          }
        ]
      },
      "feeReference": "CO5.2",
      "feeAmount": {
        "value": 1299,
        "currency": "GBP"
      },
      "offsiteFeeReference": "CO1.1",
      "offsiteFeeAmount": {
        "value": 1299,
        "currency": "GBP"
      },
      "offsiteFeeDescription": "Offsite Fee for application to Crown Court"
    }
  ]
}

Changes

  • 8a3c6d9862a3Revision changes
    • info

      the response property ////// became required for the status