Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Livesearch
spaceKeyHG
additionalpage excerpt
placeholderSearch for a solution
typepage

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.

Course Templates

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.

Field

GET
(Read)

PUT
(Update)

POST
(Create new)

Validation

Course Template ID

(blue star)

(error)

(error)

n/a

Name

(blue star)

(error)

(error)

n/a

Type

(blue star)

(error)

(error)

n/a

Category
(As an array)

(blue star)

(error)

(error)

n/a


Courses (Dates)

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.

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

CourseDateID

(blue star)

(blue star)

(error)

(error)

n/a

External ID

(blue star)

(blue star)

(blue star)

(error)

Name

(blue star)

(blue star)

(blue star)

(error)

Start Date

(blue star)

(blue star)

(blue star)

(error)

End Date

(blue star)

(blue star)

(blue star)

(error)

Minimum Sessions

(blue star)

(blue star)

(blue star)

(error)

Maximum Sessions

(blue star)

(blue star)

(blue star)

(error)

Company ID (training provider)

(blue star)

(blue star)

(blue star)

(error)

Net Cost

(blue star)

(error)

(blue star)

(error)

Tax

(blue star)

(error)

(blue star)

(error)

Charge per delegate

(blue star)

(error)

(blue star)

(error)

Status

(blue star)

(blue star)

(blue star)

(error)

Places Remaining

(blue star)

(blue star)

(error)

(error)

n/a

Waiting list in use

(blue star)

(blue star)

(blue star)

(error)


Sessional

(blue star)

(blue star)

(blue star)

(error)


Sessional Cost Type

(blue star)

(blue star)

(blue star)

(error)


Duration

(blue star)

(blue star)

(blue star)

(error)


Duration Type

(blue star)

(blue star)

(blue star)

(error)


Image URL

(blue star)

(blue star)

(error)

(error)


Aims Text

(blue star)

(blue star)

Please note that any double spaces '  ' in Aims text are not recognised when filtering API Feeds

(blue star)

(error)


Links

  • Rel: SELF, Action: GET, url: api/v1/coursedates/{id}

  • Rel: Trainers, Action: GET, url: api/v1/coursedates/{id}/trainers

  • Rel: Venues, Action: GET, url: api/v1/coursedates/{id}/venues

  • Rel: CourseTemplate, Action: GET, url: api/v1/coursetemplates/{courseid}~{companyid}

(blue star)

(error)

(error)

(error)

n/a

Course is advertised

(blue star)

(blue star)

(blue star)

(error)


Advertised start date

(blue star)

(blue star)

(blue star)

(error)

Must be before advertised end date

Advertised end date

(blue star)

(blue star)

(blue star)

(error)

Must be after advertised start date

Max places

(blue star)

(blue star)

(blue star)

(error)

Must be positive and must be higher than minimum places

Min places

(blue star)

(blue star)

(blue star)

(error)

Must be positive and must be lower than maximum places

Course is exclusive

(blue star)

(blue star)

(error)

(error)


Sessions

  • Contains the information of the sessional courses

(blue star)

(error)

(error)

(error)


Here are some example filters that you will be able to use with your Course API Feed:

Only include advertised courses:

  • {{apiroot}}/coursedates?CourseIsAdvertised=true

Only include courses that are not advertised:

  • {{apiroot}}/coursedates?CourseIsAdvertised=false

Only include a specific course

  • {{apiroot}}/coursedates?CourseDateID=12066

Only include courses with more than 3 places remaining (gt = greater than)

  • {{apiroot}}/coursedates?PlacesRemaining=gt:3

Only include courses with less than 2 places remaining (let = less than)

  • {{apiroot}}/coursedates?PlacesRemaining=lt:2

Only include courses starting at 5th Oct 2021 at 9am

  • {{apiroot}}/coursedates?StartDate=2021-10-05T09:00:00

Only include courses starting w/c 28th June 

  • {{apiroot}}/coursedates?StartDate=gt:2021-06-28T07:59:59&lt:2021-07-02T18:00:00

Only include courses that contain the words "First Aid" in the name

  • {{apiroot}}/coursedates?Name=“First Aid”

Only include available courses

  • {{apiroot}}/coursedates?Status=Available

Exclude courses that are cancelled or completed

  • {{apiroot}}/coursedates?Status=not:Completed&Status=not:Cancelled

Only include courses that do not have a start date (such as eLearning courses)

  • {{apiroot}}/coursedates?StartDate=NULL

Only include courses that do have a start date

  • {{apiroot}}/coursedates?StartDate=not:NULL


Delegates

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.

Field

GET
(Read)

PUT
(Update)

POST
(Create new)

Validation

User ID

(blue star)

(error)

(blue star) Mandatory

Must validate against an existing user

Course Date Link

(blue star)

(error)

(blue star) Mandatory

Must validate against an existing course date

Delegate Status

(blue star)

(blue star)

(blue star)

Must validate against statuses

Date Booked

(blue star)

(error)

(error)

n/a

Score

(blue star)

(blue star)

(blue star)

Numeric (0 - 100)


Trainers

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.

Field

GET
(Read)

PUT
(Update)

POST
(Create new)

Validation

Trainer Label

(blue star)

(error)

(error)

n/a

Trainer Description

(blue star)

(error)

(error)

n/a


Venues

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.

Field

GET
(Read)

PUT
(Update)

POST
(Create new)

Validation

Venue Label

(blue star)

(error)

(error)

n/a

Venue Address

(blue star)

(error)

(error)

n/a

Venue Town

(blue star)

(error)

(error)

n/a

Venue County

(blue star)

(error)

(error)

n/a

Venue Country

(blue star)

(error)

(error)

n/a

Venue Postcode

(blue star)

(error)

(error)

n/a

Venue Phone

(blue star)

(error)

(error)

n/a

Venue Email

(blue star)

(error)

(error)

n/a

Venue Website

(blue star)

(error)

(error)

n/a

Venue description

(blue star)

(error)

(error)

n/a

Connecting to the API

DISCLAIMER: By using accessplanit APIs, you agree to our terms of use.

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 csm@accessplanit.com