result-codes

Get Result Codes (paginated, filterable)

Returns a paginated list of Result Codes.

Filters:
- code – case-insensitive partial match
- title – case-insensitive partial match

get/result-codes

Request

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

Query parameters

codestring

Filter by code (contains, case-insensitive).

titlestring

Filter by title (contains, case-insensitive).

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.

[
  "title,asc"
]

Response

Page of Result 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": [
    {
      "resultCode": "RC-001",
      "title": "Application List Entry Fee Status"
    }
  ]
}

Changes

No recorded changes to this operation across all 61 revisions of this API.