Creates a course record using the CMS API v2.4.
| Method | URL |
|---|---|
POST |
/v2/courses |
| 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 |
| name | The name for the course. | Required |
| description | The description for the course. | Optional |
| national_course_id | A valid National Course ID for the course. | Optional |
https://cmsapi.cofeportal.org/v2/courses
The following search parameters can be used as part of the JSON data string:
| Name | Type | Notes |
|---|---|---|
| diocese_id | Integer | Required |
A 200 OK response, the body being a JSON object containing the created course record.
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. |
Any errors in validating the provided parameters will result in a 400 Bad Request response,
and a JSON response containing an errors array of validation error messages, keyed by
the name(s) of the parameters which caused the error(s).