Eduframe

Eduframe is a complete solution for commercial training providers & business schools to attract more students, manage & automate the course administration, and deliver the ultimate learning experience. Eduframe seamlessly integrates with Canvas LMS. The connector opens up the opportunity to easily integrate your existing software applications with Eduframe, like your CRM and accounting software.

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
Post_accounts ([Optional]Post_accountsParameterBody body)	Add an account
Get_accounts ([Optional]integer page, [Optional]integer per_page, [Optional]array include)	List all accounts
Get_accounts_id (integer id)	Get an account
Post_categories ([Optional]Post_categoriesParameterBody body)	Add a category
Get_categories ([Optional]integer page, [Optional]integer per_page, [Optional]array sort)	List all categories
Get_categories_id (integer id)	Get a category
Post_courses ([Optional]Post_coursesParameterBody body)	Add a course
Get_courses ([Optional]integer page, [Optional]integer per_page, [Optional]array sort)	List all courses
Get_courses_id (integer id)	Get a course
Post_users ([Optional]Post_usersParameterBody body)	Add a user
Get_users ([Optional]integer page, [Optional]integer per_page, [Optional]array include, [Optional]array sort)	List all users
Get_users_id (integer id, [Optional]array include)	Get a user
Post_invoices ([Optional]Post_invoicesParameterBody body)	Add an invoice
Get_invoices ([Optional]integer page, [Optional]integer per_page, [Optional]array include)	List all invoices
Get_invoices_id (integer id, [Optional]array include)	Get an invoice
Get_invoice_vats ([Optional]integer page, [Optional]integer per_page)	List all invoice vats
Post_invoice_vats ([Optional]Post_invoice_vatsParameterBody body)	Add an invoice vat
Get_labels ([Optional]integer page, [Optional]integer per_page)	List all labels

Triggers:

Name	Summary
Post_webhooks (Post_webhooksParameterBody body)	Subscribe to a webhook

Objects:

Name	Summary
account
address
category
course
invoice
invoice_item
invoice_vat
label
Post_accountsParameterBody
Post_categoriesParameterBody
Post_coursesParameterBody
Post_invoicesParameterBody
Post_invoice_vatsParameterBody
Post_usersParameterBody
Post_webhooksParameterBody
user
webhook

Actions:

Post_accounts

Summary: Add an account

Description: Add a account to your administration

Syntax:

Eduframe.Post_accounts ([Optional]Post_accountsParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_accountsParameterBody

False

Returns:

Type:account

Get_accounts

Summary: List all accounts

Description: Get all accounts.

Syntax:

Eduframe.Get_accounts ([Optional]integer page, [Optional]integer per_page, [Optional]array include)

Parameters:

Name	Type	Summary	Required	Related Action
page	integer (Page number)	Page number to get	False
per_page	integer (Records per page)	Number of records per page	False
include	array of (string) (Includes)	Include relations in the results	False

Returns:

Type:array of (account)

Get_accounts_id

Summary: Get an account

Description: Get an account by id

Syntax:

Eduframe.Get_accounts_id (integer id)

Parameters:

Name

Type

Summary

Required

Related Action

integer(int64)

(Account id)

Identifier of the account

True

Returns:

Type:account

Post_categories

Summary: Add a category

Description: Add a category to your administration

Syntax:

Eduframe.Post_categories ([Optional]Post_categoriesParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_categoriesParameterBody

False

Returns:

Type:category

Get_categories

Summary: List all categories

Description: Get all categories.

Syntax:

Eduframe.Get_categories ([Optional]integer page, [Optional]integer per_page, [Optional]array sort)

Parameters:

Name	Type	Summary	Required	Related Action
page	integer (Page number)	Page number to get	False
per_page	integer (Records per page)	Number of records per page	False
sort	array of (string) (Sort)	Sort the results. Change order by using `<sort_by>:[asc\|desc]`	False

Returns:

Type:array of (category)

Get_categories_id

Summary: Get a category

Description: Get a category by id

Syntax:

Eduframe.Get_categories_id (integer id)

Parameters:

Name

Type

Summary

Required

Related Action

integer(int64)

(Category Id)

Identifier of the category

True

Returns:

Type:category

Post_courses

Summary: Add a course

Description: Add a course to your administration

Syntax:

Eduframe.Post_courses ([Optional]Post_coursesParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_coursesParameterBody

False

Returns:

Type:course

Get_courses

Summary: List all courses

Description: Get all courses.

Syntax:

Eduframe.Get_courses ([Optional]integer page, [Optional]integer per_page, [Optional]array sort)

Parameters:

Name	Type	Summary	Required	Related Action
page	integer (Page number)	Page number to get	False
per_page	integer (Records per page)	Number of records per page	False
sort	array of (string) (Sort)	Sort the results. Change order by using `<sort_by>:[asc\|desc]`	False

Returns:

Type:array of (course)

Get_courses_id

Summary: Get a course

Description: Get a single course by id

Syntax:

Eduframe.Get_courses_id (integer id)

Parameters:

Name

Type

Summary

Required

Related Action

integer(int64)

(Course id)

Identifier of the course

True

Returns:

Type:course

Post_users

Summary: Add a user

Description: Add a user to your administration

Syntax:

Eduframe.Post_users ([Optional]Post_usersParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_usersParameterBody

False

Returns:

Type:user

Get_users

Summary: List all users

Description: Get all users.

Syntax:

Eduframe.Get_users ([Optional]integer page, [Optional]integer per_page, [Optional]array include, [Optional]array sort)

Parameters:

Name	Type	Summary	Required	Related Action
page	integer (Page number)	Page number to get	False
per_page	integer (Records per page)	Number of records per page	False
include	array of (string) (Includes)	Include relations in the results	False
sort	array of (string) (Sort)	Sort the results. Change order by using `<sort_by>:[asc\|desc]`	False

Returns:

Type:array of (user)

Get_users_id

Summary: Get a user

Description: Get a single user by id

Syntax:

Eduframe.Get_users_id (integer id, [Optional]array include)

Parameters:

Name

Type

Summary

Required

Related Action

integer(int64)

(User id)

Identifier of the user

True

include

array of (string)

(Includes)

Include relations in the results

False

Returns:

Type:user

Post_invoices

Summary: Add an invoice

Description: Add an invoice to your administration

Syntax:

Eduframe.Post_invoices ([Optional]Post_invoicesParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_invoicesParameterBody

False

Returns:

Type:invoice

Get_invoices

Summary: List all invoices

Description: Get all invoices.

Syntax:

Eduframe.Get_invoices ([Optional]integer page, [Optional]integer per_page, [Optional]array include)

Parameters:

Name	Type	Summary	Required	Related Action
page	integer (Page number)	Page number to get	False
per_page	integer (Records per page)	Number of records per page	False
include	array of (string) (Include relations)	Include relations in the results	False

Returns:

Type:array of (invoice)

Get_invoices_id

Summary: Get an invoice

Description: Get a single invoice by id

Syntax:

Eduframe.Get_invoices_id (integer id, [Optional]array include)

Parameters:

Name

Type

Summary

Required

Related Action

integer(int64)

(Invoice id)

Identifier of the invoice

True

include

array of (string)

(Includes)

Include relations in the results

False

Returns:

Type:invoice

Get_invoice_vats

Summary: List all invoice vats

Description: Get all invoice vats

Syntax:

Eduframe.Get_invoice_vats ([Optional]integer page, [Optional]integer per_page)

Parameters:

Name

Type

Summary

Required

Related Action

page

integer

(Page number)

Page number to get

False

per_page

integer

(Records per page)

Number of records per page

False

Returns:

Type:array of (invoice_vat)

Post_invoice_vats

Summary: Add an invoice vat

Description: Add an invoice vat which can be used on the invoice

Syntax:

Eduframe.Post_invoice_vats ([Optional]Post_invoice_vatsParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_invoice_vatsParameterBody

False

Returns:

Type:invoice_vat

Get_labels

Summary: List all labels

Description: Get all labels.

Syntax:

Eduframe.Get_labels ([Optional]integer page, [Optional]integer per_page)

Parameters:

Name

Type

Summary

Required

Related Action

page

integer

(Page number)

Page number to get

False

per_page

integer

(Records per page)

Number of records per page

False

Returns:

Type:array of (label)

Triggers:

Trigger Post_webhooks

Summary: Subscribe to a webhook

Description: Subscribe to a webhook to get notified on record updates

Syntax:

Eduframe.Post_webhooks (Post_webhooksParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

body

Post_webhooksParameterBody

True

Returns:

Type:webhook

account

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the account.
name	string	The account name.
email	string	A string representing the billing e-mail of the account
account_type	string	The account type. Values: [business, personal]
address	address
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

address

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the address.
addressee	string	The addressee of the address.
address	string	Concatenation of the street and house number.
postal_code	string	A string representing the postal code.
city	string	A string representing the city.
country	string	A string representing the country.
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

course

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the course
name	string	The name of the course.
position	number	Sorting position of the course. Lower is higher.
starting_price	string	Lowest price of all of its planned courses.
signup_url	string	URL to the signup page for this course.
slug	string	Human readable identifier, unique per educator.
slug_history	array of (string)	List of old slugs, old calls will be redirected.
avatar	string	URL to the original avatar image file.
website_url	string	Expected URL of the course on the educator website.
certificate_template_id	number	Identifier of the optionally linked certificate template.
category_id	number	Identifier of the category of the course.
code	string	The code of the course.
duration	string	The duration of the course.
level	string	A string indicating the level of the course.
meta_title	string	Meta title of the course for SEO purposes.
meta_description	string	Meta description of the course for SEO purposes.
result	string	The result of the course
cost	string	The price to be paid for this course.
cost_scheme	string	How should the course be paid by default. Values: [student, order, tbd, free]
is_published	boolean	Boolean representing the publishable status of the course.
program	string	The value of the property.
conditions	string	The conditions of the course.
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

invoice

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the invoice.
account_id	number	Identifier of the account.
number	string	The invoice number which is unique per educator. If left empty, it autoincrements.
number_int	number	The invoice number converted to an integer value.
status	string	The status of the invoice. The initial status will always be concept. Values: [concept, open, expired, paid, deleted]
expiration_date	string	The expiration date of the invoice. Is set when the invoice is set to open.
opened_at	string	The date when the invoice status was changed to open.
description	string	Human readable description of the invoice.
account_name	string	The name of the account that is paying. Is copied to the invoice and is thus not automatically updated if the account name changes.
currency	string	The currency of the invoice. Values: [EUR, ISK, USD, GBP]
total_incl	string	The total cost of the invoice including VAT.
total_excl	string	The total cost of the invoice excluding VAT.
pdf_url	string	Url to the download path of the invoice in PDF format.
xml_url	string	Url to the download path of the invoice in UML format.
feature	string	Some description of the invoice which is displayed on the invoice.
footnote	string	The note displayed at the bottom of the invoice.
invoice_items	array of (invoice_item)
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

invoice_item

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the invoice item.
units	integer	The number of units of the invoice item.
name	string	The name of the invoice item.
unit_price	number(float)	The price of a single unit.
invoice_vat_id	number	Identifier of the invoice vat.
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

invoice_vat

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique idenitfier of the invoice vat.
name	string	Name of the invoice vat.
percentage	number(float)	Number representing the VAT percentage.

label

Summary:

Description:

Properties:

Name	Type	Summary
id	number	Unique identifier of the label
name	string	The name of the label
color	string	Hex code of the color of the label
model_type	string	The model type for which this label is made available
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

Post_accountsParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
name	string	The account name.
email	string	A string representing the billing e-mail of the account
address_attributes	address

Post_categoriesParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
name	string	Title of the category.
description	string	The description of the category.
slug	string	Friendly identifier of a category.
position	number	Sorting position of the category. Lower is higher.
parent_id	number	The parent category
is_published	boolean	If the category should be published on the website.
meta_title	string	The meta title of the category, used for SEO (Search Engine Optimisation) purposes.
meta_description	string	The meta description of the category, used for SEO (Search Engine Optimisation) purposes.

Post_coursesParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
category_id	number	Identifier of the category of the course.
name	string	The name of the course.
code	string	The code of the course.
cost_scheme	string	How should the course be paid by default. Values: [student, order, tbd, free]
cost	string	The price to be paid for this course.
is_published	boolean	Boolean representing the publishable status of the course.
duration	string	The duration of the course.
level	string	A string indicating the level of the course.
program	string	The value of the property.
conditions	string	The conditions of the course.
result	string	The result of the course
meta_title	string	Meta title of the course for SEO purposes.
meta_description	string	Meta description of the course for SEO purposes.

Post_invoicesParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
account_id	number	Identifier of the account.
currency	string	The currency of the invoice. Values: [EUR, ISK, USD, GBP]
invoice_items_attributes	array of (invoice_item)
feature	string	Some description of the invoice which is displayed on the invoice.
footnote	string	The note displayed at the bottom of the invoice.

Post_invoice_vatsParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

name

string

Name of the invoice vat.

percentage

string

Number representing the VAT percentage.

Post_usersParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
first_name	string	First name of the user.
middle_name	string	Middle name of the user.
last_name	string	Last name of the user.
email	string	The e-mail of the user.
phone	string	The telephone number of the user.
wants_newsletter	boolean	Does the user want to receive newsletters?
with_authentication	boolean	Create an authentication for the user, such that the user is able to login.
address_attributes	address

Post_webhooksParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
url	string	The callback url for Eduframe to send a HTTP POST payload to.
active	boolean	State of webhook.
webhook_triggers_attributes	array of (Webhook_triggers_attributesItem)

Webhook_triggers_attributesItem

Summary:

Description:

Properties:

Name

Type

Summary

event

string

On which event webhook will be fired Values: [update, create]

klass

string

On which klass event be caught Values: [Category, Course, Educator, Enrollment, Lead, Meeting, MeetingLocation, Order, Payment, PlannedCourse, Plugins::EducatorPlugin, Invoice, InvoiceItem, Settings::CourseLocation, Settings::CourseVariant, Settings::InvoiceVat, TeacherEnrollment, User]

user

Summary:

Description:

Properties:

Name	Type	Summary
id	integer(int64)	Unique identifier of the user.
employee_number	string	The employee number of this user.
first_name	string	First name of the user.
middle_name	string	Middle name of the user.
last_name	string	Last name of the user.
email	string	The e-mail of the user.
phone	string	The telephone number of the user.
labels	array of (label)
slug	string	The human readable unique identifier, you can also use this to fetch the user.
wants_newsletter	boolean	Does the user want to receive newsletters?
with_authentication	boolean	Create an authentication for the user, such that the user is able to login.
address	address
roles	array of (string)	List of roles the user has.
teacher_headline	string	Short description of the user.
description	string	Long description of the user. (same as teacher_description)
teacher_description	string	Long description of the user. (same as description)
avatar_url	string	The relative url path to the avatar.
updated_at	string	Timestamp of last update.
created_at	string	Timestamp of creation.

webhook

Summary:

Description:

Properties:

Name	Type	Summary
id	number	Unique identifier of the webhook.
plugin_id	number	Unique identifier of the linked plugin.
url	string	The callback url for Eduframe to send a HTTP POST payload to.
active	boolean	State of webhook.
webhook_triggers	array of (Webhook_triggersItem)

Webhook_triggersItem

Summary:

Description:

Properties:

Name	Type	Summary
id	number	Unique identifier for the Webhook Trigger
event	string	On which event Webhook will be fired Values: [update, create]
klass	string	On which klass event be caught Values: [Category, Course, Educator, Enrollment, Lead, Meeting, MeetingLocation, Order, Payment, PlannedCourse, Plugins::EducatorPlugin, Invoice, InvoiceItem, Settings::CourseLocation, Settings::CourseVariant, Settings::InvoiceVat, TeacherEnrollment, User]
updated_at	string	Timestamp of last update
created_at	string	Timestamp of creation