1"use strict";(globalThis.webpackChunkicehrm_docs=globalThis.webpackChunkicehrm_docs||[]).push([[7525],{4931(e,s,n){n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api-docs/learn","title":"Learn API","description":"Endpoints for the Learning Management System (courses, enrollment, and quizzes).","source":"@site/docs/api-docs/learn.md","sourceDirName":"api-docs","slug":"/api-docs/learn","permalink":"/docs/api-docs/learn","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":19,"frontMatter":{"sidebar_position":19},"sidebar":"tutorialSidebar","previous":{"title":"Company Assets API","permalink":"/docs/api-docs/company-assets"},"next":{"title":"Recruitment API","permalink":"/docs/api-docs/recruitment"}}');var l=n(4848),o=n(8453);const i={sidebar_position:19},c="Learn API",t={},d=[{value:"Get All Published Courses",id:"get-all-published-courses",level:2},{value:"Get My Enrolled Courses",id:"get-my-enrolled-courses",level:2},{value:"Enroll in Course",id:"enroll-in-course",level:2},{value:"Check Lesson Quiz Answers",id:"check-lesson-quiz-answers",level:2},{value:"Related Topics",id:"related-topics",level:2}];function a(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.header,{children:(0,l.jsx)(s.h1,{id:"learn-api",children:"Learn API"})}),"\n",(0,l.jsx)(s.p,{children:"Endpoints for the Learning Management System (courses, enrollment, and quizzes)."}),"\n",(0,l.jsx)(s.h2,{id:"get-all-published-courses",children:"Get All Published Courses"}),"\n",(0,l.jsx)(s.p,{children:"Returns all published courses including the current user's enrollment status."}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:"GET /learn/course-list\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Response:"})," ",(0,l.jsx)(s.code,{children:"200 OK"})]}),"\n",(0,l.jsx)(s.h2,{id:"get-my-enrolled-courses",children:"Get My Enrolled Courses"}),"\n",(0,l.jsx)(s.p,{children:"Returns courses the current user is enrolled in."}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:"GET /learn/my-course-list\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Response:"})," ",(0,l.jsx)(s.code,{children:"200 OK"})]}),"\n",(0,l.jsx)(s.h2,{id:"enroll-in-course",children:"Enroll in Course"}),"\n",(0,l.jsx)(s.p,{children:"Enrolls the current user in a course."}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:"POST /learn/enroll\n"})}),"\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Request Body:"})}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-json",children:'{\n "course_id": 12\n}\n'})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Response:"})," ",(0,l.jsx)(s.code,{children:"200 OK"})]}),"\n",(0,l.jsx)(s.h2,{id:"check-lesson-quiz-answers",children:"Check Lesson Quiz Answers"}),"\n",(0,l.jsx)(s.p,{children:"Validates the user's answers for a lesson quiz and returns results plus completion status."}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{children:"GET /learn/lesson/{id}/check-answers\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Response:"})," ",(0,l.jsx)(s.code,{children:"200 OK"})," with quiz results and lesson completion state."]}),"\n",(0,l.jsx)(s.h2,{id:"related-topics",children:"Related Topics"}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:(0,l.jsx)(s.a,{href:"/docs/api-docs/employees",children:"Employees API"})}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},8453(e,s,n){n.d(s,{R:()=>i,x:()=>c});var r=n(6540);const l={},o=r.createContext(l);function i(e){const s=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.