GET

classbandrelationships API

Retrieve and manage classbandrelationships records from the Apps4Edu sync database.

Endpoint Path

GET /api/classbandrelationships

CURL Example

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

Field Definitions

Field	Type
`rowHash`	char
`classID`	int
`className`	varchar
`groupName`	varchar
`groupStartdate`	datetime
`groupEndDate`	datetime
`subBlockName`	varchar
`subBlockStartdate`	datetime
`subBlockEndDate`	datetime
`blockName`	varchar
`blockStartdate`	datetime
`blockEndDate`	datetime
`bandID`	int
`bandName`	varchar
`collectionTimetableCalendarID`	varchar
`calendarModelID`	int
`bandIndex`	bigint
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "rowHash": "example_value",
      "classID": 101,
      "className": "example_value",
      "groupName": "example_value",
      "groupStartdate": "example_value",
      "groupEndDate": "example_value",
      "subBlockName": "example_value",
      "subBlockStartdate": "example_value",
      "subBlockEndDate": "example_value",
      "blockName": "example_value",
      "blockStartdate": "example_value",
      "blockEndDate": "example_value",
      "bandID": 101,
      "bandName": "example_value",
      "collectionTimetableCalendarID": 101,
      "calendarModelID": 101,
      "bandIndex": "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.