{"id":485,"date":"2024-12-11T11:24:09","date_gmt":"2024-12-11T11:24:09","guid":{"rendered":"https:\/\/linqur.com\/docs\/?post_type=ht_kb&p=485"},"modified":"2024-12-11T11:24:11","modified_gmt":"2024-12-11T11:24:11","slug":"api-endpoint-documentation","status":"publish","type":"ht_kb","link":"https:\/\/linqur.com\/docs\/en\/article\/api-endpoint-documentation\/","title":{"rendered":"API endpoint documentation"},"content":{"rendered":"\n
\n

A comprehensive description of all end points.<\/p>\n<\/blockquote>\n\n\n\n

Method<\/strong><\/td>HTTP request<\/strong><\/td>Description<\/strong><\/td><\/tr>
courseAdd()<\/td>GET<\/strong> \/course\/add<\/td>Create a new course<\/td><\/tr>
courseDelete()<\/td>GET<\/strong> \/course\/delete<\/td>Delete an existing course by its ID<\/td><\/tr>
courseLearningObjectDelete()<\/td>GET<\/strong> \/course\/learningobject\/delete<\/td>Delete a specific learning object<\/td><\/tr>
courseLearningObjectScormAdd()<\/td>POST<\/strong> \/course\/learningobject\/scrom\/add<\/td>Add an SCORM package to a course<\/td><\/tr>
courseLearningObjectList()<\/td>GET<\/strong> \/course\/learningobject\/list<\/td>Get learning objects for a course<\/td><\/tr>
courseLearningObjectScormUpdate()<\/td>POST<\/strong> \/course\/learningobject\/scrom\/update<\/td>Update SCORM Learning Object<\/td><\/tr>
courseList()<\/td>GET<\/strong> \/course\/list<\/td>Retrieve all courses<\/td><\/tr>
courseLtiRegistrationsByDay()<\/td>GET<\/strong> \/course\/lti\/registrations_by_day<\/td>Get LTI registrations by day<\/td><\/tr>
courseLtiRegistrationsSumByCourse()<\/td>GET<\/strong> \/course\/lti\/registrations_sum_by_course<\/td>Get total LTI registrations per course<\/td><\/tr>
courseToolAdd()<\/td>GET<\/strong> \/course\/tool\/add<\/td>Add new tool to a course<\/td><\/tr>
courseToolDelete()<\/td>GET<\/strong> \/course\/tool\/delete<\/td>Delete a specific course tool<\/td><\/tr>
courseToolList()<\/td>GET<\/strong> \/course\/tool\/list<\/td>List all LTI tools within a course<\/td><\/tr>
courseToolUpdate()<\/td>GET<\/strong> \/course\/tool\/update<\/td>Update a specific course tool<\/td><\/tr>
courseUpdate()<\/td>GET<\/strong> \/course\/update<\/td>Update an existing course<\/td><\/tr>
tokenAdd()<\/td>GET<\/strong> \/token\/add<\/td>Add a new API token<\/td><\/tr>
tokenDelete()<\/td>GET<\/strong> \/token\/delete<\/td>Delete an API token<\/td><\/tr>
tokenList()<\/td>GET<\/strong> \/token\/list<\/td>Get list of API tokens<\/td><\/tr>
userDelete()<\/td>GET<\/strong> \/user\/delete<\/td>Delete a user by ID<\/td><\/tr>
userDeleteBulk()<\/td>GET<\/strong> \/user\/delete_bulk<\/td>Delete multiple users by IDs<\/td><\/tr>
userList()<\/td>GET<\/strong> \/user\/list<\/td>Get list of users in a tool<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

courseAdd()<\/h2>\n\n\n\n
courseAdd($coursename, $coursenameshort): \\LtiSaasApi\\Model\\CourseAdd200Response<\/code><\/pre>\n\n\n\n
Create a new course<\/strong><\/p>\n\n\n\n
This endpoint allows you to create a new course. The course name should be passed as a query parameter.<\/p>\n\n\n\n
Example<\/strong><\/p>\n\n\n\n
<?php<\/strong>\nrequire_once(__DIR__ . '\/vendor\/autoload.php');\n\n\n\/\/ Configure API key authorization: token\n$config = LtiSaasApi\\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');\n\/\/ Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n\/\/ $config = LtiSaasApi\\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');\n\n\n$apiInstance = new LtiSaasApi\\Api\\DefaultApi(\n    \/\/ If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    \/\/ This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$coursename = 'coursename_example'; \/\/ string | The name of the course to be created\n$coursenameshort = 'coursenameshort_example'; \/\/ string | The shortname of the course to be created\n\ntry {\n    $result = $apiInstance->courseAdd($coursename, $coursenameshort);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling DefaultApi->courseAdd: ', $e->getMessage(), PHP_EOL;\n}<\/code><\/pre>\n\n\n\n
Parameters<\/strong><\/a><\/p>\n\n\n\n
Name<\/th>Type<\/th>Description<\/th>Notes<\/th><\/tr><\/thead>
coursename<\/strong><\/td>string<\/strong><\/td>The name of the course to be created<\/td><\/td><\/tr>
coursenameshort<\/strong><\/td>string<\/strong><\/td>The shortname of the course to be created<\/td>[optional]<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Return type<\/strong><\/a><\/p>\n\n\n\n
\\LtiSaasApi\\Model\\CourseAdd200Response<\/p>\n\n\n\n
Authorization: token<\/a><\/p>\n\n\n\n
HTTP request headers<\/a><\/h3>\n\n\n\n