Retrieves a collection of related course records from the CMS API v2.4 based for the given contact.
| Method | URL |
|---|---|
GET |
/v2/contacts/{id}/courses |
Where {id} is the ID of the contact you wish to retrieve related course records for.
| Response format | JSON |
| Paginated? | No |
| Rate Limited? | Yes (more information) |
This API endpoint supports the following request parameters:
| Parameter | Description | Notes |
|---|---|---|
| api_id | The api_id is given to you with your access credentials. |
Required |
| data | The URL encoded JSON data string of search parameters. | Required |
| sig | The HMAC signature for this request. | Required |
| end_date | Only return records that were updated on or before this date. Dates must be formatted in the following format: YYYY-MM-DD HH:MM. |
|
| start_date | Only return records that were updated on or after this date. Dates must be formatted in the following format: YYYY-MM-DD HH:MM. |
https://cmsapi.cofeportal.org/v2/contacts/{id}/courses?api_id={api_id}&data={data}&sig={sig}
The following search parameters can be used as part of the JSON data string:
| Name | Type | Notes |
|---|---|---|
| diocese_id | Integer | Required |
A JSON object containing none or more related course records for that contact.
The following fields will be returned with the response:
| Name | Type | Notes |
|---|---|---|
| id | Integer | ID of the related course record. |
| contact_id | Integer | ID of the contact record. |
| course_id | Integer | ID of the course record. |
| qualification_id | Integer | ID of the (optional) qualification record. |
| booked_at | Date | Date the course was booked. |
| attended_at | Date | Date the course was attended. |
| completed_at | Date | Date the course was completed. |
| expires_at | Date | Date the course expires. |
| course_name | String | Name of the course. |
| qualification_name | String | Name of the (optional) qualification. |