GET

periodstructures API

Retrieve and manage periodstructures records from the Apps4Edu sync database.

Endpoint Path

GET /api/periodstructures

CURL Example

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

Field Definitions

Field	Type
`calendarModelID`	int
`calendarTypeID`	int
`calendarTypeName`	varchar
`calendarTypeDescription`	varchar
`calendarModelName`	varchar
`calendarModelDescription`	varchar
`defaultDatePart`	varchar
`defaultStartTime`	datetime
`defaultEndTime`	datetime
`cardinality`	int
`sortOrder`	int
`dataPermissions`	int
`defaultCalendarName`	varchar
`periodDisplayName`	varchar
`appliedStartDate`	datetime
`appliedEndDate`	datetime
`weekNumber`	varchar
`weekDisplayName`	varchar
`dayOfWeek`	varchar
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "calendarModelID": 101,
      "calendarTypeID": 101,
      "calendarTypeName": "example_value",
      "calendarTypeDescription": "example_value",
      "calendarModelName": "example_value",
      "calendarModelDescription": "example_value",
      "defaultDatePart": "example_value",
      "defaultStartTime": "example_value",
      "defaultEndTime": "example_value",
      "cardinality": "example_value",
      "sortOrder": "example_value",
      "dataPermissions": true,
      "defaultCalendarName": "example_value",
      "periodDisplayName": true,
      "appliedStartDate": "example_value",
      "appliedEndDate": "example_value",
      "weekNumber": "example_value",
      "weekDisplayName": true,
      "dayOfWeek": "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.