PublishedRevisions

Manage operations with published course revisions.

GET /published-revisions[/:link]

Get published revision by application link. Custom header "password" can be used to pass course password.

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

SupportCategories

GET /support-categories

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /support-categories[/:support_categories_id]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

SupportArticles

GET /support-articles

Fields

Field Type Description Required
comments_count NO
user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /support-articles[/:support_articles_id]

Fields

Field Type Description Required
comments_count NO
user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /support-articles[/:support_articles_id]

Fields

Field Type Description Required
comments_count NO
user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Users

GET /users

Fields

Field Type Description Required
password NO
link NO
email NO
name NO
about NO
active NO
roles NO
display_name NO
profile_picture NO
team_name NO
first_name NO
last_name NO
company NO
phone NO
address_line_1 NO
city NO
postal_code NO
address_line_2 NO
country_code NO
vatin NO
job_title NO
site_link NO
team_icon NO
team_background NO
plan NO
date_of_birth NO
team_website NO
team_facebook NO
team_twitter NO
team_linked_in NO
team_instagram NO
paypal_account NO
team_youtube NO
comments_mode NO
verified NO
analytic_script NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /users

Fields

Field Type Description Required
password NO
link NO
email NO
name NO
about NO
active NO
roles NO
display_name NO
profile_picture NO
team_name NO
first_name NO
last_name NO
company NO
phone NO
address_line_1 NO
city NO
postal_code NO
address_line_2 NO
country_code NO
vatin NO
job_title NO
site_link NO
team_icon NO
team_background NO
plan NO
date_of_birth NO
team_website NO
team_facebook NO
team_twitter NO
team_linked_in NO
team_instagram NO
paypal_account NO
team_youtube NO
comments_mode NO
verified NO
analytic_script NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /users[/:users_id]

Fields

Field Type Description Required
password NO
link NO
email NO
name NO
about NO
active NO
roles NO
display_name NO
profile_picture NO
team_name NO
first_name NO
last_name NO
company NO
phone NO
address_line_1 NO
city NO
postal_code NO
address_line_2 NO
country_code NO
vatin NO
job_title NO
site_link NO
team_icon NO
team_background NO
plan NO
date_of_birth NO
team_website NO
team_facebook NO
team_twitter NO
team_linked_in NO
team_instagram NO
paypal_account NO
team_youtube NO
comments_mode NO
verified NO
analytic_script NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /users[/:users_id]

Fields

Field Type Description Required
password NO
link NO
email NO
name NO
about NO
active NO
roles NO
display_name NO
profile_picture NO
team_name NO
first_name NO
last_name NO
company NO
phone NO
address_line_1 NO
city NO
postal_code NO
address_line_2 NO
country_code NO
vatin NO
job_title NO
site_link NO
team_icon NO
team_background NO
plan NO
date_of_birth NO
team_website NO
team_facebook NO
team_twitter NO
team_linked_in NO
team_instagram NO
paypal_account NO
team_youtube NO
comments_mode NO
verified NO
analytic_script NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /users[/:users_id]

Fields

Field Type Description Required
password NO
link NO
email NO
name NO
about NO
active NO
roles NO
display_name NO
profile_picture NO
team_name NO
first_name NO
last_name NO
company NO
phone NO
address_line_1 NO
city NO
postal_code NO
address_line_2 NO
country_code NO
vatin NO
job_title NO
site_link NO
team_icon NO
team_background NO
plan NO
date_of_birth NO
team_website NO
team_facebook NO
team_twitter NO
team_linked_in NO
team_instagram NO
paypal_account NO
team_youtube NO
comments_mode NO
verified NO
analytic_script NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Courses

GET /courses

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /courses[/:courses_id]

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /courses[/:courses_id]

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /courses[/:courses_id]

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /courses[/:courses_id]

Fields

Field Type Description Required
name NO
privacy_setting NO
user_id NO
title NO
description NO
keywords NO
price_regular_1 NO
price_regular_2 NO
price_regular_3 NO
price_sale_1 NO
price_sale_2 NO
price_sale_3 NO
language NO
time_to_complete NO
skill_level NO
certificate_validity NO
certificate_renew_period NO
status NO
origin_course_id NO
comments_count Comments count NO
enrollments_count NO
likes_count NO
dislikes_count NO
password NO
comments_allowed NO
type NO
file_hash NO
thumbnail Course icon file NO
territory NO
price_regular_4 NO
price_regular_5 NO
price_regular_6 NO
price_regular_7 NO
price_regular_8 NO
price_regular_9 NO
price_regular_10 NO
price_regular_11 NO
price_regular_12 NO
price_sale_4 NO
price_sale_5 NO
price_sale_6 NO
price_sale_7 NO
price_sale_8 NO
price_sale_9 NO
price_sale_10 NO
price_sale_11 NO
price_sale_12 NO
editable NO
responsive NO
audio NO
video NO
quizzes NO
accessible NO
plugin_free NO
copies_count NO
downloads_count NO
showcase_full_course_id NO
showcase_media_url NO
showcase_mode NO
analytic_script NO
file_extension NO
interactive NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Templates

GET /templates

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /templates[/:templates_id]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CoursesLikes

GET /courses-likes

Fields

Field Type Description Required
course_id YES
liked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-likes

Fields

Field Type Description Required
course_id YES
liked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /courses-likes[/:courses_likes_id]

Fields

Field Type Description Required
course_id YES
liked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-likes[/:courses_likes_id]

Fields

Field Type Description Required
course_id YES
liked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /courses-likes[/:courses_likes_id]

Fields

Field Type Description Required
course_id YES
liked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Enrollments

GET /enrollments

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /enrollments

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /enrollments[/:enrollments_id]

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /enrollments[/:enrollments_id]

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /enrollments[/:enrollments_id]

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /enrollments[/:enrollments_id]

Fields

Field Type Description Required
course_id YES
enrolled_user_id YES
date_enrolled NO
date_completed NO
date_approval NO
approved_by_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

TeamMembers

GET /team-members

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /team-members

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /team-members[/:team_user_id]

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /team-members[/:team_user_id]

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /team-members[/:team_user_id]

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /team-members[/:team_user_id]

Fields

Field Type Description Required
user_id NO
team_user_id NO
is_blocked NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

AllowedUsers

GET /allowed-users

Fields

Field Type Description Required
course_id YES
allowed_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /allowed-users

Fields

Field Type Description Required
course_id YES
allowed_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /allowed-users[/:allowed_users_id]

Fields

Field Type Description Required
course_id YES
allowed_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CoursesRevisions

Manage operations with course revisions.

GET /courses-revisions

Fields

Field Type Description Required
content content of whole course in JSON format YES
course_link Course link YES
published mark revision as published (boolean parameter) NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-revisions

Fields

Field Type Description Required
content content of whole course in JSON format YES
course_link Course link YES
published mark revision as published (boolean parameter) NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /courses-revisions[/:revisions_id]

Fields

Field Type Description Required
content content of whole course in JSON format YES
course_link Course link YES
published mark revision as published (boolean parameter) NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /courses-revisions[/:revisions_id]

Fields

Field Type Description Required
content content of whole course in JSON format YES
course_link Course link YES
published mark revision as published (boolean parameter) NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /courses-revisions[/:revisions_id]

Fields

Field Type Description Required
content content of whole course in JSON format YES
course_link Course link YES
published mark revision as published (boolean parameter) NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

AuthTokens

GET /auth-tokens[/:one_time_hash]

Fields

Field Type Description Required
one_time_hash NO
expire_date Date when token expires in format: 2004-10-19 10:23:54 NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /auth-tokens[/:one_time_hash]

Fields

Field Type Description Required
one_time_hash NO
expire_date Date when token expires in format: 2004-10-19 10:23:54 NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /auth-tokens[/:one_time_hash]

Fields

Field Type Description Required
one_time_hash NO
expire_date Date when token expires in format: 2004-10-19 10:23:54 NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

LatestRevisions

Manage operations with latest course revisions.

GET /latest-revisions[/:link]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CoursesDislikes

GET /courses-dislikes

Fields

Field Type Description Required
course_id YES
disliked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-dislikes

Fields

Field Type Description Required
course_id YES
disliked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-dislikes[/:courses_dislikes_id]

Fields

Field Type Description Required
course_id YES
disliked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /courses-dislikes[/:courses_dislikes_id]

Fields

Field Type Description Required
course_id YES
disliked_by_user_id YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Wishlists

GET /wishlists

Optional parameters: page and itemsPerPage: paging searchPhrase: search filterStatus: filter by status

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /wishlists

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /wishlists[/:wishlists_id]

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /wishlists[/:wishlists_id]

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /wishlists[/:wishlists_id]

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /wishlists[/:wishlists_id]

Fields

Field Type Description Required
course_id YES
wished_by_user_id YES
status NO
reject_reason NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CheckToken

GET /check-token[/:auth_token]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CourseFinish

POST /course-finish

Fields

Field Type Description Required
link course link YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /course-finish[/:course_finish_id]

Fields

Field Type Description Required
link course link YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Comments

GET /comments

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /comments

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /comments[/:comments_id]

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /comments[/:comments_id]

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

POST /comments[/:comments_id]

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /comments[/:comments_id]

Fields

Field Type Description Required
parent_id Parent comment in thread NO
user_id User id who created comment YES
comment Comment text posted by user YES
status Comment status NO

Request

Headers

Header Value
Accept
application/json
application/*+json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Reports

GET /reports

Fields

Field Type Description Required
user_id YES

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /reports

Fields

Field Type Description Required
user_id YES

Request

Headers

Header Value
Accept
application/json
application/*+json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /reports[/:reports_id]

Fields

Field Type Description Required
user_id YES

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /reports[/:reports_id]

Fields

Field Type Description Required
user_id YES

Request

Headers

Header Value
Accept
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

POST /reports[/:reports_id]

Fields

Field Type Description Required
user_id YES

Request

Headers

Header Value
Accept
application/json
application/*+json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

UploadScorm

POST /upload-scorm

Fields

Field Type Description Required
qqfile Zend\InputFilter\FileInput YES
qquuid NO
qqfilename NO
qqtotalfilesize NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
multipart/form-data
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /upload-scorm[/:upload_scorm_id]

Fields

Field Type Description Required
qqfile Zend\InputFilter\FileInput YES
qquuid NO
qqfilename NO
qqtotalfilesize NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /upload-scorm[/:upload_scorm_id]

Fields

Field Type Description Required
qqfile Zend\InputFilter\FileInput YES
qquuid NO
qqfilename NO
qqtotalfilesize NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
multipart/form-data
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

UploadMedia

POST /upload-media

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
multipart/form-data
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /upload-media[/:upload_media_id]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
multipart/form-data
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

UploadSizeLimit

GET /upload-size-limit

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

UserRoles

GET /user-roles

Fields

Field Type Description Required
roles Array of roles for user YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /user-roles

Fields

Field Type Description Required
roles Array of roles for user YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /user-roles[/:role_id]

Fields

Field Type Description Required
roles Array of roles for user YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

CoursesTags

GET /courses-tags[/:courses_tags_id]

Fields

Field Type Description Required
course_id YES
tags YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-tags[/:courses_tags_id]

Replace existing tags with new collection of tags

Fields

Field Type Description Required
course_id YES
tags YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CourseCategories

GET /course-categories

Fields

Field Type Description Required
name NO
url NO
type NO
territory NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /course-categories[/:course_category_id]

Fields

Field Type Description Required
name NO
url NO
type NO
territory NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /course-categories[/:course_category_id]

Fields

Field Type Description Required
name NO
url NO
type NO
territory NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /course-categories[/:course_category_id]

Fields

Field Type Description Required
name NO
url NO
type NO
territory NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /course-categories[/:course_category_id]

Fields

Field Type Description Required
name NO
url NO
type NO
territory NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CoursesCategories

GET /courses-categories[/:courses_categories_id]

Fields

Field Type Description Required
course_id YES
categories YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /courses-categories[/:courses_categories_id]

Fields

Field Type Description Required
course_id YES
categories YES

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

EdjetTokens

DELETE /edjet-tokens

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

GET /edjet-tokens

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /edjet-tokens

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /edjet-tokens[/:edjet_tokens_id]

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /edjet-tokens[/:edjet_tokens_id]

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /edjet-tokens[/:edjet_tokens_id]

Fields

Field Type Description Required
active NO
table_name NO
item_id NO
valid_thru NO
validity_period NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Purchases

GET /purchases

Fields

Field Type Description Required
price YES
user_id YES
course_id NO
seats NO
price_mode NO
price_mode_type NO
course_variant NO
copy_course_id NO
status NO
type YES
price_regular NO
plan NO
mode YES
course_link NO
item_name NO
publisher_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /purchases

Fields

Field Type Description Required
price YES
user_id YES
course_id NO
seats NO
price_mode NO
price_mode_type NO
course_variant NO
copy_course_id NO
status NO
type YES
price_regular NO
plan NO
mode YES
course_link NO
item_name NO
publisher_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /purchases[/:purchase_id]

Fields

Field Type Description Required
price YES
user_id YES
course_id NO
seats NO
price_mode NO
price_mode_type NO
course_variant NO
copy_course_id NO
status NO
type YES
price_regular NO
plan NO
mode YES
course_link NO
item_name NO
publisher_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /purchases[/:purchase_id]

Fields

Field Type Description Required
price YES
user_id YES
course_id NO
seats NO
price_mode NO
price_mode_type NO
course_variant NO
copy_course_id NO
status NO
type YES
price_regular NO
plan NO
mode YES
course_link NO
item_name NO
publisher_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /purchases[/:purchase_id]

Fields

Field Type Description Required
price YES
user_id YES
course_id NO
seats NO
price_mode NO
price_mode_type NO
course_variant NO
copy_course_id NO
status NO
type YES
price_regular NO
plan NO
mode YES
course_link NO
item_name NO
publisher_user_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Seats

GET /seats

Fields

Field Type Description Required
course_id YES
manager_user_id YES
users YES
date_notified NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /seats

Fields

Field Type Description Required
course_id YES
manager_user_id YES
users YES
date_notified NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /seats[/:seat_id]

Fields

Field Type Description Required
course_id YES
manager_user_id YES
users YES
date_notified NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Invitations

GET /invitations

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /invitations

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /invitations

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /invitations[/:invitations_id]

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /invitations[/:invitations_id]

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /invitations[/:invitations_id]

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

POST /invitations[/:invitations_id]

Fields

Field Type Description Required
team_id NO
email NO
invited_member_dto NO
status NO
id NO
date_created NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DemoCourses

GET /showcase-courses

Fields

Field Type Description Required
showcase_full_course_id YES
demo_course_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /showcase-courses

Fields

Field Type Description Required
showcase_full_course_id YES
demo_course_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /showcase-courses[/:demo_courses_id]

Fields

Field Type Description Required
showcase_full_course_id YES
demo_course_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /showcase-courses[/:demo_courses_id]

Fields

Field Type Description Required
showcase_full_course_id YES
demo_course_id NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CoursesSummary

GET /courses-summary[/:courses_summary_id]

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

ScormPackages

Retrieve SCORM package in ZIP format based on course link.

POST /scorm-packages[/:course_link]

Fields

Field Type Description Required
course_link YES
format NO

Request

Headers

Header Value
Accept
application/vnd.edjet.v1+json
application/hal+json
application/json
Content-Type
application/vnd.edjet.v1+json
application/json
Authorization HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.edjet.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body