Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

← Knowledge Base Homepage

← Plug-ins and Integration Homepage

← Information for your Web Developers Homepage

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

✅

(error)

(error)

n/a

Name

✅

(error)

(error)

n/a

Type

✅

(error)

(error)

n/a

Category
(As an array)

✅

(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

✅

✅

(error)

(error)

n/a

External ID

✅

✅

✅

(error)

Name

✅

✅

✅

(error)

Start Date

✅

✅

✅

(error)

End Date

✅

✅

✅

(error)

Minimum Sessions

✅

✅

✅

(error)

Maximum Sessions

✅

✅

✅

(error)

Company ID (training provider)

✅

✅

✅

(error)

Net Cost

✅

(error)

✅

(error)

Tax

✅

(error)

✅

(error)

Charge per delegate

✅

(error)

✅

(error)

Status

✅

✅

✅

(error)

Places Remaining

✅

✅

(error)

(error)

n/a

Waiting list in use

✅

✅

✅

(error)


Sessional

✅

✅

✅

(error)


Sessional Cost Type

✅

✅

✅

(error)


Duration

✅

✅

✅

(error)


Duration Type

✅

✅

✅

(error)


Image URL

✅

✅

(error)

(error)


Aims Text

✅

✅

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

✅

(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}

✅

(error)

(error)

(error)

n/a

Course is advertised

✅

✅

✅

(error)


Advertised start date

✅

✅

✅

(error)

Must be before advertised end date

Advertised end date

✅

✅

✅

(error)

Must be after advertised start date

Max places

✅

✅

✅

(error)

Must be positive and must be higher than minimum places

Min places

✅

✅

✅

(error)

Must be positive and must be lower than maximum places

Course is exclusive

✅

✅

(error)

(error)


Sessions

  • Contains the information of the sessional courses

✅

(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


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

✅

(error)

✅ Mandatory

Must validate against an existing user

Course Date Link

✅

(error)

✅ Mandatory

Must validate against an existing course date

Delegate Status

✅

✅

✅

Must validate against statuses

Date Booked

✅

(error)

(error)

n/a

Score

✅

✅

✅

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

✅

(error)

(error)

n/a

Trainer Description

✅

(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

✅

(error)

(error)

n/a

Venue Address

✅

(error)

(error)

n/a

Venue Town

✅

(error)

(error)

n/a

Venue County

✅

(error)

(error)

n/a

Venue Country

✅

(error)

(error)

n/a

Venue Postcode

✅

(error)

(error)

n/a

Venue Phone

✅

(error)

(error)

n/a

Venue Email

✅

(error)

(error)

n/a

Venue Website

✅

(error)

(error)

n/a

Venue description

✅

(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

On this page:

  • No labels