{"id":490,"date":"2024-12-11T12:05:38","date_gmt":"2024-12-11T12:05:38","guid":{"rendered":"https:\/\/linqur.com\/docs\/?post_type=ht_kb&p=490"},"modified":"2024-12-11T12:05:38","modified_gmt":"2024-12-11T12:05:38","slug":"practical-applications-of-the-api","status":"publish","type":"ht_kb","link":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/","title":{"rendered":"Practical applications of the API"},"content":{"rendered":"\n
\n

Utilizing the APIs on the Linqur platform allows for efficient management of courses, users, tools, and learning objects.<\/p>\n<\/blockquote>\n\n\n\n

Below is an overview of how you can use these APIs for various tasks:<\/p>\n\n\n\n

Managing Courses<\/strong><\/h2>\n\n\n\n
    \n
  • Create a Course<\/strong>: Use courseAdd to add a new course. Provide the course name and, optionally, a short name.<\/li>\n\n\n\n
  • Update a Course<\/strong>: With courseUpdate, you can modify the details of an existing course, such as its name or short name, by specifying the course ID.<\/li>\n\n\n\n
  • Delete a Course<\/strong>: To remove a course, courseDelete requires the course ID.<\/li>\n<\/ul>\n\n\n\n

    Managing Learning Objects<\/strong><\/h2>\n\n\n\n
      \n
    • List Learning Objects<\/strong>: Retrieve a list of learning objects in a course using courseLearningobjectList by providing the course ID.<\/li>\n\n\n\n
    • Add a SCORM Package<\/strong>: Use courseLearningObjectScromAdd to add a SCORM package as a learning object to a specified course.<\/li>\n\n\n\n
    • Update SCORM Learning Object<\/strong>: Modify the details of a SCORM learning object within a course using courseLearningobjectScormUpdate.<\/li>\n\n\n\n
    • Delete Learning Object<\/strong>: To remove a learning object, use courseLearningObjectDelete with the learning object ID.<\/li>\n<\/ul>\n\n\n\n

      Managing Tools and LTI Integrations<\/strong><\/h2>\n\n\n\n
        \n
      • List Tools<\/strong>: Retrieve all tools within a course using courseToolList. You need to provide the course ID.<\/li>\n\n\n\n
      • Add a Tool<\/strong>: Use courseToolAdd to add a new tool to a course. You’ll need to provide details like the course ID, LTI version, and tool name.<\/li>\n\n\n\n
      • Update a Tool<\/strong>: Modify the details of a tool using courseToolUpdate. This requires the tool ID and the details to be updated.<\/li>\n\n\n\n
      • Delete a Tool<\/strong>: Remove a tool from a course using courseToolDelete with the tool ID.<\/li>\n<\/ul>\n\n\n\n

        Managing Users<\/strong><\/h2>\n\n\n\n
          \n
        • List Users<\/strong>: userList provides a list of users registered in a specific tool.<\/li>\n\n\n\n
        • Delete a User<\/strong>: Remove a user from the system with userDelete by providing the user ID.<\/li>\n\n\n\n
        • Bulk Delete Users<\/strong>: To delete multiple users at once, userDeleteBulk allows you to provide a list of user IDs.<\/li>\n<\/ul>\n\n\n\n

          API Token Management<\/strong><\/h2>\n\n\n\n
            \n
          • List API Tokens<\/strong>: View all API tokens using tokenList.<\/li>\n\n\n\n
          • Add an API Token<\/strong>: Create a new API token for your applications with tokenAdd.<\/li>\n\n\n\n
          • Delete an API Token<\/strong>: Use tokenDelete to remove an API token from the system.<\/li>\n<\/ul>\n\n\n\n

            These APIs facilitate a wide range of operations on the Linqur platform, from basic course management to advanced configurations and integrations. Understanding and utilizing these APIs can significantly enhance the efficiency and effectiveness of managing e-learning content and tools on the platform.<\/p>\n","protected":false},"excerpt":{"rendered":"

            Utilizing the APIs on the Linqur platform allows for efficient management of courses, users, tools, and learning objects. Below is an overview of how you can use these APIs for various tasks: Managing Courses Managing Learning Objects Managing Tools and LTI Integrations Managing Users API Token Management These APIs facilitate…<\/p>\n","protected":false},"author":3,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[155],"ht-kb-tag":[67,76],"class_list":["post-490","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-linqur-api","ht_kb_tag-api","ht_kb_tag-manage"],"yoast_head":"\nPractical applications of the API | Linqur knowledge base<\/title>\n<meta name=\"description\" content=\"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Practical applications of the API | Linqur knowledge base\" \/>\n<meta property=\"og:description\" content=\"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Linqur knowledge base\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/\",\"url\":\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/\",\"name\":\"Practical applications of the API | Linqur knowledge base\",\"isPartOf\":{\"@id\":\"https:\/\/linqur.com\/docs\/en\/#website\"},\"datePublished\":\"2024-12-11T12:05:38+00:00\",\"description\":\"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.\",\"breadcrumb\":{\"@id\":\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/linqur.com\/docs\/en\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Practical applications of the API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/linqur.com\/docs\/en\/#website\",\"url\":\"https:\/\/linqur.com\/docs\/en\/\",\"name\":\"Linqur documentation and help articles\",\"description\":\"How-to articles and more\",\"publisher\":{\"@id\":\"https:\/\/linqur.com\/docs\/en\/#organization\"},\"alternateName\":\"Linqur docs\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/linqur.com\/docs\/en\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/linqur.com\/docs\/en\/#organization\",\"name\":\"Linqur LTI Solutions\",\"alternateName\":\"Linqur\",\"url\":\"https:\/\/linqur.com\/docs\/en\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/linqur.com\/docs\/en\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/linqur.com\/docs\/wp-content\/uploads\/2024\/12\/Group-442@2x.png\",\"contentUrl\":\"https:\/\/linqur.com\/docs\/wp-content\/uploads\/2024\/12\/Group-442@2x.png\",\"width\":600,\"height\":600,\"caption\":\"Linqur LTI Solutions\"},\"image\":{\"@id\":\"https:\/\/linqur.com\/docs\/en\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.linkedin.com\/company\/linqur-lti-solutions\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Practical applications of the API | Linqur knowledge base","description":"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/","og_locale":"en_US","og_type":"article","og_title":"Practical applications of the API | Linqur knowledge base","og_description":"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.","og_url":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/","og_site_name":"Linqur knowledge base","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/","url":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/","name":"Practical applications of the API | Linqur knowledge base","isPartOf":{"@id":"https:\/\/linqur.com\/docs\/en\/#website"},"datePublished":"2024-12-11T12:05:38+00:00","description":"Explore the comprehensive details of Practical Applications of the REST API at Linqur. Find all the necessary information and insights.","breadcrumb":{"@id":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/linqur.com\/docs\/en\/article\/practical-applications-of-the-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/linqur.com\/docs\/en\/"},{"@type":"ListItem","position":2,"name":"Practical applications of the API"}]},{"@type":"WebSite","@id":"https:\/\/linqur.com\/docs\/en\/#website","url":"https:\/\/linqur.com\/docs\/en\/","name":"Linqur documentation and help articles","description":"How-to articles and more","publisher":{"@id":"https:\/\/linqur.com\/docs\/en\/#organization"},"alternateName":"Linqur docs","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/linqur.com\/docs\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/linqur.com\/docs\/en\/#organization","name":"Linqur LTI Solutions","alternateName":"Linqur","url":"https:\/\/linqur.com\/docs\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/linqur.com\/docs\/en\/#\/schema\/logo\/image\/","url":"https:\/\/linqur.com\/docs\/wp-content\/uploads\/2024\/12\/Group-442@2x.png","contentUrl":"https:\/\/linqur.com\/docs\/wp-content\/uploads\/2024\/12\/Group-442@2x.png","width":600,"height":600,"caption":"Linqur LTI Solutions"},"image":{"@id":"https:\/\/linqur.com\/docs\/en\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/linqur-lti-solutions\/"]}]}},"_links":{"self":[{"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb\/490","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/comments?post=490"}],"version-history":[{"count":1,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb\/490\/revisions"}],"predecessor-version":[{"id":491,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb\/490\/revisions\/491"}],"wp:attachment":[{"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/media?parent=490"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb-category?post=490"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/linqur.com\/docs\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=490"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}