GET

examcomponents API

Retrieve and manage examcomponents records from the Apps4Edu sync database.

Endpoint Path

GET /api/examcomponents

CURL Example

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

Field Definitions

Field	Type
`componentID`	int
`examOptionID`	int
`gradesetID`	int
`gradeset`	varchar
`componentTime`	varchar
`componentTypeID`	int
`componentType`	varchar
`assessmentModeID`	int
`assessmentMode`	varchar
`componentCode`	varchar
`localName`	varchar
`boardTitle`	text
`componentDate`	datetime
`duration`	int
`maximumMark`	int
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "componentID": 101,
      "examOptionID": 101,
      "gradesetID": 101,
      "gradeset": "example_value",
      "componentTime": "example_value",
      "componentTypeID": 101,
      "componentType": "example_value",
      "assessmentModeID": 101,
      "assessmentMode": "example_value",
      "componentCode": "example_value",
      "localName": "example_value",
      "boardTitle": "example_value",
      "componentDate": "example_value",
      "duration": "example_value",
      "maximumMark": "example_value",
      "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.