API Docs
lms-community
contributor > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
course__creator_organization | |
user_profile | |
course | |
course__is_upload_completed | |
course__is_course_verified |
contributor > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
course_id |
contributor > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this contributor. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course__creator_organization | |
user_profile | |
course | |
course__is_upload_completed | |
course__is_course_verified |
contributor > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this contributor. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course__creator_organization | |
user_profile | |
course | |
course__is_upload_completed | |
course__is_course_verified |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
course_id |
contributor > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this contributor. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course__creator_organization | |
user_profile | |
course | |
course__is_upload_completed | |
course__is_course_verified |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
course_id |
contributor > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this contributor. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course__creator_organization | |
user_profile | |
course | |
course__is_upload_completed | |
course__is_course_verified |
student > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
user_profile |
student > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
guardian_name | |
school |
student > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
student > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
guardian_name | |
school |
student > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
guardian_name | |
school |
student > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
teacher > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
pinned | |
user_profile |
teacher > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
is_allowed_to_add_course | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
order | |
pinned |
teacher > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
pinned | |
user_profile |
teacher > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
pinned | |
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
is_allowed_to_add_course | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
order | |
pinned |
teacher > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
pinned | |
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_profile_id | |
slug | |
is_allowed_to_add_course | |
facebook_link | |
instagram_link | |
linkedin_link | |
twitter_link | |
personal_website_link | |
email_address | |
contact_number | |
order | |
pinned |
teacher > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
pinned | |
user_profile |
lms-content
course > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
course > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
course > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
course > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course-admin > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course-admin > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
course-admin > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course-admin > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
course-admin > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator_organization | |
subject | |
subject__slug | |
subject__topic__slug | |
is_featured | |
is_top | |
is_upcoming_course | |
is_upload_completed |
course-step > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
course | |
course__slug | |
parent_id |
course-step > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_id | |
course_id | |
video_id | |
reading_material_id | |
quiz_id | |
slug | |
step_order | |
title | |
content_type |
course-step > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course step. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course | |
course__slug | |
parent_id |
course-step > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course step. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course | |
course__slug | |
parent_id |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_id | |
course_id | |
video_id | |
reading_material_id | |
quiz_id | |
slug | |
step_order | |
title | |
content_type |
course-step > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course step. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course | |
course__slug | |
parent_id |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_id | |
course_id | |
video_id | |
reading_material_id | |
quiz_id | |
slug | |
step_order | |
title | |
content_type |
course-step > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course step. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
course | |
course__slug | |
parent_id |
media > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
media > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file |
media > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this media. |
media > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this media. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file |
media > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this media. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
file |
media > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this media. |
process > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
subject | |
is_featured | |
is_top |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
featured_image | |
creator_organization_id | |
subject_id | |
slug | |
title | |
description | |
estimate_time_completion | |
forum_link | |
is_featured | |
is_top | |
is_upload_completed | |
is_course_verified | |
is_upcoming_course | |
order |
quiz-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
quiz_set |
quiz-item > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_set_id | |
quiz_set | |
answer_type | |
question | |
order |
quiz-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz item. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_set |
quiz-item > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz item. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_set |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_set_id | |
quiz_set | |
answer_type | |
question | |
order |
quiz-item > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz item. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_set |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_set_id | |
quiz_set | |
answer_type | |
question | |
order |
quiz-item > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz item. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_set |
quiz-option > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
quiz_item |
quiz-option > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_item_id | |
order | |
option | |
is_correct_answer |
quiz-option > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz option. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_item |
quiz-option > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz option. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_item |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_item_id | |
order | |
option | |
is_correct_answer |
quiz-option > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz option. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_item |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
quiz_item_id | |
order | |
option | |
is_correct_answer |
quiz-option > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz option. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
quiz_item |
quiz-set > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
quiz-set > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
quiz-set > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz set. |
quiz-set > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz set. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
quiz-set > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz set. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
quiz-set > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz set. |
reading-material > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
reading-material > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description |
reading-material > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this reading material. |
reading-material > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this reading material. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description |
reading-material > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this reading material. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description |
reading-material > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this reading material. |
subject > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
topic |
subject > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
topic required | |
title | |
slug | |
order |
subject > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this subject. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
topic |
subject > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this subject. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
topic |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
topic required | |
title | |
slug | |
order |
subject > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this subject. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
topic |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
topic | |
title | |
slug | |
order |
subject > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this subject. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
topic |
topic > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
topic > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
slug | |
order | |
featured_image |
topic > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this topic. |
topic > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this topic. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
slug | |
order | |
featured_image |
topic > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this topic. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
slug | |
order | |
featured_image |
topic > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this topic. |
video > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
video > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
is_a_iframe_video | |
iframe_code | |
video_content | |
description |
video > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this video. |
video > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this video. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
is_a_iframe_video | |
iframe_code | |
video_content | |
description |
video > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this video. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
is_a_iframe_video | |
iframe_code | |
video_content | |
description |
video > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this video. |
lms-enroll
progress > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
is_complete | |
course | |
student |
progress > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
course | |
current_course_step | |
student_id | |
course_id | |
current_course_step_id | |
is_complete | |
student |
progress > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this progress. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_complete | |
course | |
student |
progress > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this progress. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_complete | |
course | |
student |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
course | |
current_course_step | |
student_id | |
course_id | |
current_course_step_id | |
is_complete | |
student |
progress > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this progress. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_complete | |
course | |
student |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
course | |
current_course_step | |
student_id | |
course_id | |
current_course_step_id | |
is_complete | |
student |
progress > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this progress. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_complete | |
course | |
student |
quiz-attempt > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
student | |
quizset |
quiz-attempt > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
student_id | |
quizset_id | |
gained_marks | |
student | |
quizset |
quiz-attempt > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz attempt. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
student | |
quizset |
quiz-attempt > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz attempt. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
student | |
quizset |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
student_id | |
quizset_id | |
gained_marks | |
student | |
quizset |
quiz-attempt > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz attempt. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
student | |
quizset |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
student_id | |
quizset_id | |
gained_marks | |
student | |
quizset |
quiz-attempt > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this quiz attempt. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
student | |
quizset |
lms-forum
comment > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
post |
comment > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
author | |
post_id required | |
body |
comment > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
post |
comment > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
post |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
author | |
post_id required | |
body |
comment > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
post |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
author | |
post_id | |
body |
comment > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
post |
post > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
author | |
topic |
post > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
topic_id | |
author | |
slug | |
title | |
body |
post > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
author | |
topic |
post > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
author | |
topic |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
topic_id | |
author | |
slug | |
title | |
body |
post > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
author | |
topic |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
author_id | |
topic_id | |
author | |
slug | |
title | |
body |
post > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
author | |
topic |
lms-home
homepage-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
homepage-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this homepage item. |
lms-info
code-of-conduct > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
code-of-conduct > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Code of Conduct. |
faqs > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
faqs > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this FAQs. |
privacy-policy > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
privacy-policy > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this PrivacyPolicy. |
lms-notification
custom-notification > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
user | |
seen | |
clicked |
custom-notification > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
seen | |
clicked |
custom-notification > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this custom notification. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user | |
seen | |
clicked |
custom-notification > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this custom notification. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user | |
seen | |
clicked |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
seen | |
clicked |
custom-notification > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this custom notification. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user | |
seen | |
clicked |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
seen | |
clicked |
custom-notification > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this custom notification. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user | |
seen | |
clicked |
notification-message > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
notification-message > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type | |
title | |
body | |
link | |
user |
notification-message > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this notification message. |
notification-message > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this notification message. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type | |
title | |
body | |
link | |
user |
notification-message > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this notification message. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type | |
title | |
body | |
link | |
user |
notification-message > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this notification message. |
lms-organization
member > delete > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this members. |
member > organization > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
organization_id required |
organization > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
user_profile |
organization > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
logo | |
slug | |
title | |
link | |
created_by | |
user_profile |
organization > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this organization. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
organization > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this organization. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
logo | |
slug | |
title | |
link | |
created_by | |
user_profile |
organization > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this organization. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
logo | |
slug | |
title | |
link | |
created_by | |
user_profile |
organization > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this organization. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_profile |
open-resource
json > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
json > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owner required | |
category required | |
name required | |
description required | |
json | |
comment required |
json > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JSON Content. |
json > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JSON Content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owner required | |
category required | |
name required | |
description required | |
json | |
comment required |
json > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JSON Content. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
owner | |
category | |
name | |
description | |
json | |
comment |
json > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JSON Content. |
user-auth
login > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | |
password required |
user-profile
check-reset-answer > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_id required | |
answer required | |
last_login | |
is_superuser | Designates that this user has all permissions without explicitly assigning them. |
first_name | |
last_name | |
email | |
is_staff | Designates whether the user can log into this admin site. |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
date_joined | |
groups | The groups this user belongs to. A user will get all permissions granted to each of their groups. |
user_permissions | Specific permissions for this user. |
general-profile > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
user_type |
general-profile > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
selected_security_question_id required | |
avatar | |
profile_type | |
first_name | |
last_name | |
address | |
designation | |
bio | |
contact_number | |
security_question_answer | |
user required | |
user_type | |
selected_security_question |
general-profile > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this general profile. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_type |
general-profile > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this general profile. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_type |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
selected_security_question_id required | |
avatar | |
profile_type | |
first_name | |
last_name | |
address | |
designation | |
bio | |
contact_number | |
security_question_answer | |
user required | |
user_type | |
selected_security_question |
general-profile > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this general profile. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_type |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
selected_security_question_id | |
avatar | |
profile_type | |
first_name | |
last_name | |
address | |
designation | |
bio | |
contact_number | |
security_question_answer | |
user | |
user_type | |
selected_security_question |
general-profile > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this general profile. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_type |
reset-password > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
last_login | |
is_superuser | Designates that this user has all permissions without explicitly assigning them. |
first_name | |
last_name | |
is_staff | Designates whether the user can log into this admin site. |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
date_joined | |
groups | The groups this user belongs to. A user will get all permissions granted to each of their groups. |
user_permissions | Specific permissions for this user. |
security-question > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
security-question > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this security question. |
set-password > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email required | |
last_login | |
is_superuser | Designates that this user has all permissions without explicitly assigning them. |
first_name | |
last_name | |
is_staff | Designates whether the user can log into this admin site. |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
date_joined | |
groups | The groups this user belongs to. A user will get all permissions granted to each of their groups. |
user_permissions | Specific permissions for this user. |
update-password > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
password required | |
answer required | |
user_id required | |
last_login | |
is_superuser | Designates that this user has all permissions without explicitly assigning them. |
first_name | |
last_name | |
email | |
is_staff | Designates whether the user can log into this admin site. |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
date_joined | |
groups | The groups this user belongs to. A user will get all permissions granted to each of their groups. |
user_permissions | Specific permissions for this user. |
user > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
user > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
password required | |
old_password | |
generalprofile |
user > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user. |
user > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email | |
password | |
old_password | |
generalprofile |
user-type > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
user-type > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user type. |
user-token
create
Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | |
password required |
refresh > create
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
refresh required |
verify > create
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
token required |
wd-about
about-us > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_type |
about-us > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this About Us. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page_type |
our-partner > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
partner_organization_type | |
pinned |
our-partner > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this our partner. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
partner_organization_type | |
pinned |
our-team > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
team_name | |
pinned |
our-team > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this our team. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
team_name | |
pinned |
wd-account
invoice > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email_address | |
paid_by_client | |
payment_status | |
price |
invoice > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this invoice. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email_address | |
paid_by_client | |
payment_status | |
price |
wd-category
about-page-type > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
about-page-type > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this about page type. |
footer-section > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
footer-section > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this footer section. |
homepage-section > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
homepage-section > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this homepage section. |
job-category > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
job-category > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Job Category. |
partner-organization-type > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
partner-organization-type > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this partner organization type. |
project-category > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
project-category > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project Category. |
resource-category > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
resource-category > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Resource Category. |
story-category > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
story-category > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Story Category. |
team-name > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
team-name > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this team name. |
wd-comment
reply > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
user_id | |
parent_comment_id |
reply > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_comment_id required | |
reply |
reply > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Reply. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
parent_comment_id |
reply > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Reply. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
parent_comment_id |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_comment_id required | |
reply |
reply > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Reply. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
parent_comment_id |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent_comment_id | |
reply |
reply > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Reply. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
parent_comment_id |
user-comment > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
story_id | |
user_id | |
story__slug |
user-comment > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
story_id required | |
comment |
user-comment > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
story_id | |
user_id | |
story__slug |
user-comment > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
story_id | |
user_id | |
story__slug |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
story_id required | |
comment |
user-comment > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
story_id | |
user_id | |
story__slug |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
story_id | |
comment |
user-comment > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user comment. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
story_id | |
user_id | |
story__slug |
wd-contactform
contact > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
email | |
message |
wd-donate
donation-record > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
payment_complete | |
payment_verified | |
payment_ref_id | |
donation_id | |
currency | |
amount | |
donors_comment | |
donation_in_honor | |
donation_in_memory | |
person_to_be_notified | |
email_of_person_to_be_notified | |
message_to_person_to_be_notified | |
donors_first_name | |
donors_last_name | |
donors_email | |
donors_phone | |
donors_country | |
donors_address | |
donors_postal_code | |
donors_city | |
donors_state | |
donors_employer | |
donors_occupation | |
donors_wants_to_talk | |
verification_response_message | |
payment_gateway |
donation-record > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this online donation record. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
payment_complete | |
payment_verified | |
payment_ref_id | |
donation_id | |
currency | |
amount | |
donors_comment | |
donation_in_honor | |
donation_in_memory | |
person_to_be_notified | |
email_of_person_to_be_notified | |
message_to_person_to_be_notified | |
donors_first_name | |
donors_last_name | |
donors_email | |
donors_phone | |
donors_country | |
donors_address | |
donors_postal_code | |
donors_city | |
donors_state | |
donors_employer | |
donors_occupation | |
donors_wants_to_talk | |
verification_response_message | |
payment_gateway |
other-donation-option > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
other-donation-option > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this other donation option. |
page-content > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
page-content > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this page content. |
payment-gateway > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
payment-gateway > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this payment gateway. |
wd-home
homepage-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
homepage-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this homepage item. |
wd-investor
wd-layout
footer-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
footer-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this footer item. |
menu-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
menu-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this menu item. |
sub-menu-item > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sub-menu-item > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this sub menu item. |
wd-legal
code-of-conduct > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
code-of-conduct > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Code of Conduct. |
privacy-policy > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
privacy-policy > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this PrivacyPolicy. |
wd-newsletter
visitors-email > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
email_address |
wd-post
job-vacancy > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
category |
job-vacancy > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Job Vacancy. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category |
map-data > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
map-data > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Map Data. |
map-province-data > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
map-province-data > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this map province data. |
project > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
category | |
pinned | |
show_in_map_only | |
slug |
project > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
pinned | |
show_in_map_only | |
slug |
resource > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
category | |
pinned | |
show_in_map_only | |
slug |
resource > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
pinned | |
show_in_map_only | |
slug |
resource-file > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
resource-file > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this resource file. |
story > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
category | |
pinned | |
show_in_map_only | |
slug |
story > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
pinned | |
show_in_map_only | |
slug |
story > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
slug required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
pinned | |
show_in_map_only | |
slug |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
published_by | |
slug | |
title | |
description | |
featured_image | |
claps | |
show_in_map_only | |
master_route | |
pinned | |
category |