Retrieves a collection of course records from the CMS API v2.4.
| Method | URL |
|---|---|
GET |
/v2/courses |
| Response format | JSON |
| Paginated? | Yes (more information) |
| 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 |
| limit | The number of records to return. The default is 100 records. The maximum records you can return in one response is 1000. | |
| offset | The number of rows to skip before beginning the returned rows. |
https://cmsapi.cofeportal.org/v2/courses?api_id={api_id}&data={data}&sig={sig}&limit={limit}&offset={offset}
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 CMS courses or an error response.
The following fields will be returned with the response:
| Name | Type | Notes |
|---|---|---|
| id | Integer | ID of the course. |
| name | String | Name of the course. |
| description | String | Description of the course. |
| national_course_id | Integer | National Course ID for the course. |