Settings

API key
Output

Request

Last request
POST

Calls

contact/getById

Returns a contact by ID

ID

contact/insert

Inserts contact information

Salutation ID
Firstname
Lastname
Company
Department
Phone
Mobile
Email
Street
Housenumber
City
Zipcode
Country id
Language id
VAT
Website
Tags (comma seperated)
Note

contact/validate

Validate contact information

Salutation ID
Firstname
Lastname
Company
Department
Phone
Mobile
Email
Street
Housenumber
City
Zipcode
Country id
Language id
VAT
Website
Tags (comma seperated)
Note

country/getAll

Returns all countries

country/getById

Returns a country by ID

ID

course/getAll

Returns all courses

course/getById

Returns a course by ID

ID

course/getUpdatedSince

Search for updated courses

date

course/searchBetweenDates

Search a course starting between the given dates.

date_start
date_end

course/type/getAll

Returns all course types

course/type/getById

Returns the details of a course type

id

course/type/module/getByCourseTypeId

Returns the course type module ids

courseTypeId

course/type/module/getById

Returns the course type module by its id

id

customer/authenticate

Authenticates a customer

username
email
password

customer/getInfo

Gives all information of a customer

username
email

customer/isPartOf

Checks if the default organization of the customer has a certain type

username
type

customer/project/survey/complete

Submit the results of the customer project survey

customer_project_survey_id
q1
q2
q3
q4
q5
q6
q7

customer/student/getAll

Returns the customer students

customer/student/getById

Returns the customer students by id

id

customer/student/getUpdatedSince

Returns customer students updated since

date

customer/student/search

customer/partner/getAll

Returns partners

customer/partner/getByCountry

Returns partners by given country

id

customer/partner/getById

Returns a partner

id

customer/partner/getUpdatedSince

Returns partners updated since

date

customer/partner/search

ecampus/start

Starts an ecampus course

username
The username of the customer who logged in
classname
The classname of the eCampus object

username
classname

ecampus/begin

Starts an ecampus course

username
The username of the customer who logged in
classname
The classname of the eCampus object

username
classname

ecampus/pass

Pass an ecampus course

username
The username of the customer who logged in
classname
The classname of the eCampus object

username
classname

ecampus/getSurveyUrl

Get the URL to the survey for an ecampus course

username
The username of the customer who logged in
classname
The classname of the eCampus object

username
classname

ecampus/getSurveyStatus

Get the status of the survey for an ecampus course

username
The username of the customer who logged in
classname
The classname of the eCampus object

username
classname

email/send

Sends a predefined email to a customer

email_type_short_name
A predefined email type. Can be found in OLT Admin interface
from
Can be one of the predefined from-addresses: email_default, email_support, email_onlinecatalog, email_app_development, email_ecampus

username
email_type_short_name
from

etsapplication/getAll

Returns all available ETS applications.

etsapplication/getById

Returns an ETS Application, together with its pictures and texts.

id

etsapplication/getLatestVersionByAppId

Returns the latest version of an ETS App

id

etsapplication/getLatestVersionByNumber

Returns the latest version of an ETS App

number

feed/item/event/insert

Inserts feed item event information

Date
Name
Street
Housenumber
City
Zipcode
Country id
Start date
Event date

file/getByUuid

Returns an File.

uuid

file/insert

Stores a file
Content should be a base64 encoded string

name
content

ipsolution/getAll

Returns id of all Ip Solutions

ipsolution/getById

Returns the details of an Ip Solutions with the given ID

id

ipsolution/getByOrganizationId

Returns id of all Ip Solutions of the given organization ID

id

language/getAll

Returns languages

language/getById

Returns a language

id

lms/start

Starts an LMS course

username
The username of the customer who logged in
classname
The classname of the LMS object

username
classname

lms/begin

Starts an LMS course

username
The username of the customer who logged in
classname
The classname of the LMS object

username
classname

lms/pass

Pass an LMS course

username
The username of the customer who logged in
classname
The classname of the LMS object

username
classname

newsletter/interest/getAll

Returns the newsletter interests

newsletter/interest/subscribe

Subscribe to a newsletter interest

identifier*
email*
language_id**
firstname**
lastname**
salutation_id
street
housenumber
zipcode
city
country_id
phone
mobile
company
department

* Mandatory
** Mandatory for new contact only

organization/associated_partner/getAll

Returns the organizations that are associated partners

organization/associated_partner/getById

Returns the associated partner by id

id

organization/associated_partner/getByCountry

Returns the associated partner by country

country_id

organization/associated_partner/getUpdatedSince

Returns associated partners updated since

date

organization/manufacturer/getAll

Returns the organizations that are members

organization/manufacturer/getById

Returns the member by id

id

organization/manufacturer/getByCountry

Returns the members by country

id

organization/manufacturer/getUpdatedSince

Returns members updated since

date

organization/member/getAll

Returns the organizations that are members

organization/member/getById

Returns the member by id

id

organization/member/getByCountry

Returns the members by country

id

organization/member/getUpdatedSince

Returns members updated since

date

organization/national/getAll

Returns the organizations that are national groups

organization/national/getById

Returns the national group by id

id

organization/national/getByCountry

Returns the members by country

id

organization/national/getUpdatedSince

Returns national groups updated since

date

organization/national/getDownloadsById

Returns the downloads by organization id

id

organization/national/getNationalPagesById

Returns the national pages by organization id

id

organization/national/getMembers

Returns the national group members by organization id

id

organization/scientific/getAll

Returns the organizations that are members

organization/scientific/getById

Returns the member by id

id

organization/scientific/getByCountry

Returns the members by country

id

organization/scientific/getUpdatedSince

Returns members updated since

date

organization/startup/getAll

Returns the organizations that are startups

organization/startup/getById

Returns the startup by id

id

organization/startup/getByCountry

Returns the startups by country

id

organization/startup/getUpdatedSince

Returns startups updated since

date

organization/test_lab/getAll

Returns the organizations that are test labs

organization/test_lab/getById

Returns the test lab by id

id

organization/test_lab/getByCountry

Returns the test labs by country

id

organization/test_lab/getUpdatedSince

Returns test labs updated since

date

organization/trainingcentre/getAll

Returns the organizations that are trainingcentres

organization/trainingcentre/getById

Returns the trainingcentre by id

id

organization/trainingcentre/getByCountry

Returns the trainingcentres by country

id

organization/trainingcentre/getUpdatedSince

Returns trainingcentres updated since

date

organization/nextgen_institute/getAll

Returns the organizations that are NextGen institutes

organization/nextgen_institute/getById

Returns the NextGen institute by id

id

organization/nextgen_institute/getByCountry

Returns the NextGen institutes by country

id

organization/nextgen_institute/getUpdatedSince

Returns NextGen institutes updated since

date

organization/user_club/getAll

Returns the organizations that are user clubs

organization/user_club/getById

Returns the user_club by id

id

organization/user_club/getUpdatedSince

Returns user clubs updated since

date

organization/user_club/getMembers

Returns the user club members by organization id

id

product/getTotalByStatus

Returns total products per status

status_id
country_id

product/getByStatus

Returns products per status

status_id
country_id

product/getByOrganizationId

Returns products for a specific organizatation/manufacturer

organization_id
status_id

person/getById

Get a person based on its ID

id

person/getByEmail

Get a person based on its Email address

email

person/getUpdatedSince

Returns persons updated since

date

salutation/getAll

Returns salutations

salutation/getById

Returns a salutation

id

survey/complete

Mark a survey as completed (Used by Surveygizmo)

customer_survey_id

tag/getAll

Get all tags

tag/getById

Get a tag based on its ID

id

tag/search

utility/getTotalByStatus

Returns total utilities per status

status_id
country_id

utility/getByStatus

Returns utilities per status

status_id
country_id

utility/getByOrganizationId

Returns utilities for a specific organizatation/manufacturer

organization_id
status_id

voucher/create

Create a voucher from a voucher code list

voucher code list prefix

voucher/insert

Inserts a voucher from a voucher code list to a specific customer

username
voucher code list prefix

webinar/getById

Get a webinar based on its ID

id

webinar/getAll

Returns all webinars

webinar/getUpcoming

Returns all upcoming webinars