- This line was added.
- This line was removed.
- Formatting was changed.
The Courses and Delegates API feeds 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 Feed
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 feeds included for Course and Delegate data.
Each of these five feeds have varying levels of read, write, and create access.
This feed is used for accessing the details of Course Templates within the database.
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.
Course Template ID
This feed is used for accessing the details of Courses (dates) within the database. Please note, it is not possible to create Courses via this feed but it is possible to update them.
Company ID (training provider)
Charge per delegate
Waiting list in use
Sessional Cost Type
Please note that any double spaces ' ' in Aims text are not recognised when filtering API Feeds
Course is advertised
Advertised start date
Must be before advertised end date
Advertised end date
Must be after advertised start date
Must be positive and must be higher than minimum places
Must be positive and must be lower than maximum places
Course is exclusive
Here are some example filters that you will be able to use with your Course API Feed:
Only include advertised courses:
Only include courses that are not advertised:
Only include a specific course
Only include courses with more than 3 places remaining (gt = greater than)
Only include courses with less than 2 places remaining (let = less than)
Only include courses starting at 5th Oct 2021 at 9am
Only include courses starting w/c 28th June
Only include courses that contain the words "First Aid" in the name
Only include available courses
Exclude courses that are cancelled or completed
Only include courses that do not have a start date (such as eLearning courses)
Only include courses that do have a start date
This feed is used for accessing the details of Delegates. Delegates are Users assigned to Courses. It is possible to read, update, and create Delegate records via the feed.
Must validate against an existing user
Course Date Link
Must validate against an existing course date
Must validate against statuses
Numeric (0 - 100)
This feed is used for accessing the details of Trainers.
It is not possible to update or create new Trainers - this task must be completed in the accessplanit platform.
This feed is used for accessing the details of Venues.
It is not possible to update or create new Venues - this task must be completed in the accessplanit platform.
Connecting to the API
To gain access to your accessplanit platform's API Feeds or to ask any questions about them, please speak to the CSM team at accessplanit on email@example.com
On this page:
|Table of Contents|