Course API Feeds
On this page:
Useful Helpguide Links
https://accessplanit.atlassian.net/wiki/spaces/HG/pages/423362584
https://accessplanit.atlassian.net/wiki/spaces/HG/pages/407044197
https://accessplanit.atlassian.net/wiki/spaces/HG/pages/356089948
Useful External Links
https://www.accessplanit.com/api-terms-of-use
https://documenter.getpostman.com/view/10924757/2sA3kYgzB9
The Course API feed endpoints allow you to integrate Course and Delegate information with other software that you have in use across your business, such as a LMS, VLE, or CRM.
The feed is available if you have the API Feeds module. Please speak to your CSM to find out more about this module.
Purpose of the API Feeds
This Course and Delegates API Feeds can be used to connect your accessplanit platform to other learning/training or employee-based software, such as your VLE system to sync your employee's learning records, or your intranet to display your upcoming courses.
Connecting your software and syncing the data between them removes the need for double data entry, reduces the risk of human error and eases the headache of managing multiple platforms!
Fields Available in the API Feeds
There are five endpoints available for Course data, please see the below tables for the data that is available in each.
Each of these five feeds have different levels of reading, creating, and updating, the tables below explain what actions are available for the fields in each feed.
Course Templates
This feed is used for accessing the details of Course Templates within the database.
Please note, it is not possible to update Course Templates or create new Course Templates via the feed. These actions should always be managed by an Administrator within the accessplanit platform.
It is not possible to filter the results of GET request for Course Templates, other than specifying the specific Course Template via the Training Provider:
{{apiroot}}/companies/[training provider company id]/courses/[course template ID]
Field | GET | GET | PUT | POST | Validation for PUT & POST |
|---|---|---|---|---|---|
Course Template ID |
|
|
|
| n/a |
Name |
|
|
|
| n/a |
Type |
|
|
|
| n/a |
Category |
|
|
|
| n/a |
Course Template Custom Fields |
|
|
|
| n/a |
Here is an example of a Course Template with custom fields in the feed:
Courses (Dates)
This feed is used for accessing the details of Courses (dates) within the database.
It is possible to update some information about Courses and create new Courses.
It is also possible to assign Trainers and Venues to Courses via POST requests:
{{apiroot}}/coursedates/[course date ID]/venue/[venue ID]
{{apiroot}}/coursedates/[course date ID]/trainers/[trainer ID]
You can also filter the results of a GET request for Courses, please see the GET (Filter) column in the table below to see which fields can be filtered, below this table you can find example filters that you can use.
Field | GET | GET | PUT | POST | Validation for PUT & POST |
|---|---|---|---|---|---|
CourseDateID |
|
|
|
| n/a |
External ID |
|
|
|
| Max characters 255 |
Name |
|
| | | Max characters 255 |
Start Date |
|
| Mandatory | | Must be before end date |
End Date |
|
| Mandatory | | Must be after advertised start date |
Date Updated |
|
|
|
| n/a |
Time Zone |
|
|
|
| n/a |
Minimum Sessions |
|
|
|
| n/a |
Maximum Sessions |
|
|
|
| n/a |
Company ID |
|
|
|
| Must be the ID of an existing Training Provider Account |
Net Cost |
|
|
|
| Number |
Tax |
|
|
|
| n/a |
Charge Per Delegate |
|
|
|
| True (charge per delegate) or False (charge per session) |
Status |
|
| Mandatory | Mandatory | Available, Cancelled, Completed, Failed, FullyBooked, InProgress, OnHold, Provisional, or Unknown. |
Places Remaining |
|
|
|
| n/a |
Waiting List Type |
|
|
|
| n/a |
Sessional |
|
|
|
| n/a |
Sessional Cost Type |
|
|
|
| CourseDateCost, CourseDateCostPlusOptionalSessions, CourseDateCostPlusSessions, SumOfSessions, or Unknown |
Duration |
|
|
|
| Number |
Duration Type |
|
|
|
| Day, Hour, or Minute |
Image URL |
|
|
|
| n/a |
Aims Text |
|
|
|
| Please note that any double spaces ' ' in Aims text are not recognised when filtering API Feeds |
Course Is Advertised |
|
|
|
| True or False |
Advertised Start Date |
|
|
|
| Must be before advertised end date |
Advertised End Date |
|
|
|
| Must be after advertised start date |
Max places |
|
| Mandatory | Mandatory | Must be positive and must be equal to or higher than minimum places |
Min places |
|
|
| | Must be positive and must be equal to or lower than maximum places |
Course Is Exclusive |
|
|
|
| n/a |
Sessions (As an array) Contains the information of the sessional courses |
|
|
|
| n/a |
Location |
|
|
|
|
Contact Our Team
If you can't find what you're looking for, access our Support Portal, and our team of experts will be happy to help!
Is it your first time contacting the team? Learn how to raise a support ticket.
Follow Us
Copyright © 2025 accessplanit.
Social media icons by icons8.com