GET

examoptions API

Retrieve and manage examoptions records from the Apps4Edu sync database.

Endpoint Path

GET /api/examoptions

CURL Example

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

Field Definitions

Field	Type
`rowHash`	char
`examOptionID`	int
`qualificationID`	int
`boardID`	int
`seriesID`	int
`levelID`	int
`levelDescription`	text
`itemTypeDescription`	text
`processTypeDescription`	text
`resultType`	varchar
`examOptionCode`	varchar
`examOptionLocalName`	varchar
`examOptionBoardTitle`	text
`examOptionFee`	decimal
`qcaCode`	varchar
`qcaNumber`	varchar
`submitted`	tinyint
`startDate`	datetime
`endDate`	datetime
`examOptionItemTypeID`	int
`examOptionProcessTypeID`	int
`itemTypeID`	int
`processTypeID`	int
`levelName`	varchar
`f1GradesetID`	int
`f2GradesetID`	int
`e1GradesetID`	int
`e2GradesetID`	int
`r1GradesetID`	int
`r2GradesetID`	int
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "rowHash": "example_value",
      "examOptionID": 101,
      "qualificationID": 101,
      "boardID": 101,
      "seriesID": 101,
      "levelID": 101,
      "levelDescription": "example_value",
      "itemTypeDescription": "example_value",
      "processTypeDescription": "example_value",
      "resultType": "example_value",
      "examOptionCode": "example_value",
      "examOptionLocalName": "example_value",
      "examOptionBoardTitle": "example_value",
      "examOptionFee": "example_value",
      "qcaCode": "example_value",
      "qcaNumber": "example_value",
      "submitted": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "examOptionItemTypeID": 101,
      "examOptionProcessTypeID": 101,
      "itemTypeID": 101,
      "processTypeID": 101,
      "levelName": "example_value",
      "f1GradesetID": 101,
      "f2GradesetID": 101,
      "e1GradesetID": 101,
      "e2GradesetID": 101,
      "r1GradesetID": 101,
      "r2GradesetID": 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.