HMhm-courts-and-tribunals-service
result-codes

Get a specific Result Code by code and date.

Changed on

Returns the Result Code matching the supplied code and valid on the supplied date.

get/result-codes/{code}

Request

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

Path parameters

codestring required

Code used to identify the Result Code (case-insensitive).

Query parameters

datestring date required

ISO date (yyyy-MM-dd) on which the Result Code must be valid.

Response

Result Code found

resultCodestring required

Code that identifies the result.

titlestring required

Human-readable title.

startDatestring date required

Date the Result Code became active.

endDatestring date nullable required

Date the Result Code became inactive. null indicates that this row is still active.

Example response

{
  "resultCode": "RC-001",
  "title": "Application List Entry Fee Status",
  "wording": {
    "template": "This is a test {{Applicant number}} with a date",
    "substitution-key-constraints": [
      {
        "key": "account-number",
        "value": "12345678",
        "constraint": {
          "type": "TEXT",
          "length": 1234
        }
      }
    ]
  },
  "startDate": "2025-12-01",
  "endDate": "2025-12-31"
}

Changes

  • 8a3c6d9862a3Revision changes
    • info

      the response property /// became required for the status