GET

candidateresults API

Retrieve and manage candidateresults records from the Apps4Edu sync database.

Endpoint Path

GET /api/candidateresults

CURL Example

curl "https://api.apps4education.co.uk/api/candidateresults?api_token=YOUR_TOKEN" \
-H "Accept: application/json"

Field Definitions

Field	Type
`candidateID`	int
`examOptionID`	int
`candidateEntryID`	int
`firstResult`	varchar
`secondResult`	varchar
`firstResultAsPoint`	varchar
`secondResultAsPoint`	varchar
`resultsEmbargoed`	int
`endorsementToFirstGrade`	varchar
`endorsementToSecondGrade`	varchar
`componentResults`	varchar
`componentID`	int
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "candidateID": 101,
      "examOptionID": 101,
      "candidateEntryID": 101,
      "firstResult": "example_value",
      "secondResult": "example_value",
      "firstResultAsPoint": "example_value",
      "secondResultAsPoint": "example_value",
      "resultsEmbargoed": "example_value",
      "endorsementToFirstGrade": "example_value",
      "endorsementToSecondGrade": "example_value",
      "componentResults": "example_value",
      "componentID": 101,
      "created_at": "example_value",
      "updated_at": "example_value",
      "school_id": "example_value"
    }
  ]
}

Query Parameters

api_token

Required. Your unique API key must be passed as a query string parameter.

school

Optional. A Bromcom school ID to restrict rows to one school.

page

Optional. Defaults to 1. Used to navigate through paginated results.

per_page

Optional. Rows per page, up to 500 (the default). Follow next_page_url for the rest.