Education
Get courses list
- Description:
- Returns list of courses from selected LMS.
- Endpoint:
https://api.softbook.app/lms/v1/education/courses/
- HTTP Method:
- GET
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID
);
$url = "https://api.softbook.app/lms/v1/education/courses?".http_build_query($array_params, '', '&');
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HEADER, false);
$result = curl_exec($ch);
curl_close($ch);
Get course items list
- Description:
- Returns list of lessons and modules from selected course.
- Endpoint:
https://api.softbook.app/lms/v1/education/course/
- HTTP Method:
- GET
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID course_id
*int Your Course ID
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID,
"course_id" => YOUR_COURSE_ID
);
$url = "https://api.softbook.app/lms/v1/education/course?".http_build_query($array_params, '', '&');
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HEADER, false);
$result = curl_exec($ch);
curl_close($ch);
Get lesson data
- Description:
- Returns the data from the selected lesson.
- Endpoint:
https://api.softbook.app/lms/v1/education/lesson/
- HTTP Method:
- GET
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID course_id
*int Your Course ID lesson_id
*int Your Lesson ID
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID,
"course_id" => YOUR_COURSE_ID,
"lesson_id" => YOUR_LESSON_ID
);
$url = "https://api.softbook.app/lms/v1/education/lesson?".http_build_query($array_params, '', '&');
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HEADER, false);
$result = curl_exec($ch);
curl_close($ch);
Add student
- Description:
- Add student in LMS.
- Endpoint:
https://api.softbook.app/lms/v1/education/student/
- HTTP Method:
- POST
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID course_id
*int Your Course ID student_group
*int Your Group ID first_name
string Student First Name last_name
string Student Last Name email
*string Student Email send_email
*bool Send email notification to student with auth data
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID,
"course_id" => YOUR_COURSE_ID,
"student_group" => STUDENT_GROUP_ID,
"first_name" => "STUDENT_FIRST_NAME",
"last_name" => "STUDENT_LAST_NAME",
"email" => "STUDENT_EMAIL",
"send_email" => false
);
$data = json_encode($array_params);
$url = "https://api.softbook.app/lms/v1/education/student/";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, "Content-Type: application/json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
curl_close($ch);
Delete student
- Description:
- Delete student from LMS.
- Endpoint:
https://api.softbook.app/lms/v1/education/student/{student_id}
- HTTP Method:
- DELETE
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID student_id
*int Student ID
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID
);
$data = json_encode($array_params);
$url = "https://api.softbook.app/lms/v1/education/student/{student_id}";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, "Content-Type: application/json");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
curl_close($ch);
Add teacher
- Description:
- Add teacher in LMS.
- Endpoint:
https://api.softbook.app/lms/v1/education/teacher/
- HTTP Method:
- POST
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID course_id
*int Your Course ID first_name
string Student First Name last_name
string Student Last Name email
*string Student Email send_email
*bool Send email notification to teacher with auth data
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID,
"course_id" => YOUR_COURSE_ID,
"first_name" => "STUDENT_FIRST_NAME",
"last_name" => "STUDENT_LAST_NAME",
"email" => "STUDENT_EMAIL",
"send_email" => false
);
$data = json_encode($array_params);
$url = "https://api.softbook.app/lms/v1/education/teacher/";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, "Content-Type: application/json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
curl_close($ch);
Delete teacher
- Description:
- Delete teacher from LMS.
- Endpoint:
https://api.softbook.app/lms/v1/education/teacher/{teacher_id}
- HTTP Method:
- DELETE
- Requires authentication:
- true
- Parameters:
-
* indicates requirement. Highlighted params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/json
.Variable Type Description api_key
*string Your API key lms_id
*int Your LMS ID teacher_id
*int Teacher ID
PHP request example
$array_params = array(
"api_key" => "YOUR_API_KEY",
"lms_id" => YOUR_LMS_ID
);
$data = json_encode($array_params);
$url = "https://api.softbook.app/lms/v1/education/teacher/{teacher_id}";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, "Content-Type: application/json");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
curl_close($ch);