For Developers
Get Period
GET https://ed.link/api/v2/graph/periods/:period_id
Retrieve information about a specific Period.
Request Parameters
Parameter | Location | Type | Description |
---|---|---|---|
period_id | url | string | The UUID of the desired Period. |
Sample Request
axios.get('https://ed.link/api/v2/graph/periods/00000000-0000-0000-0000-000000000000', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": {
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-05T20:32:40.454Z",
"updated_date": "2021-07-12T21:44:23.126Z",
"name": "Period 1",
"description": "Cohort 1 - Math",
"start_time": "2021-07-05T08:30:00.000Z",
"end_time": "2021-07-05T09:20:00.000Z",
"type": "class",
"flags": ["elective"],
"school_ids": ["00000000-0000-0000-0000-000000000000"],
"identifiers": [],
"properties": {}
},
"$request": "00000000-0000-0000-0000-000000000000"
}