Download start dates, end dates, deadlines, places for a course using GET for multiple course ids.
For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.
| Name | Required | Value | Description |
|---|---|---|---|
| course_ids | required | array | An array of course ids |
| limit | optional | number | Amount of results (default: 25) (maximum: 250) |
| page | optional | number | Page to show (default: 1) |
| since_id | optional | number | Restrict results to after the specified ID. |
| created_at_min | optional | string | Show items created after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| created_at_max | optional | string | Show items created before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| updated_at_min | optional | string | Show items last updated after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| updated_at_max | optional | string | Show items last updated before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| start_date_at_min | optional | string | Show items with start date after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss). The keyword 'now' can be passed in to indicate the current date and time. |
| start_date_at_max | optional | string | Show items with start date before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss). The keyword 'now' can be passed in to indicate the current date and time. |
| end_date_at_min | optional | string | Show items with end date after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss). The keyword 'now' can be passed in to indicate the current date and time. |
| end_date_at_max | optional | string | Show items with end date before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss). The keyword 'now' can be passed in to indicate the current date and time. |
| status_id | optional | integer | Restrict result to a status
|
| order_by | optional | string | Sort by field. Can be either 'id' or 'startdate'. |
| order_direction | optional | string | Sort direction. Can be either 'asc' or 'desc'. |
| include[] | optional | string | Request additional information by specifying the 'include' parameter as a path using dot notation. You can include multiple objects at once by specifying multiple items in the include array. Supported items for this endpoint: `course.products` `instructors` |
$request_url = 'https://api.frontcore.com/v2/batch/coursedates';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'X-API-Key: {your-api-key}',
'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);
If the method is successful it responds with an JSON structure, as it is shown below.
[]
Unsuccessful response sample:
{
"error": "Wrong API Key"
}