/kolibri-web-api

Primary LanguageJavaScript

kolibri_api

KolibriApi - JavaScript client for kolibri_api Kolibri Swagger API This SDK is automatically generated by the Swagger Codegen project:

  • API version: v0
  • Package version: v0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install kolibri_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your kolibri_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('kolibri_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var KolibriApi = require('kolibri_api');

var defaultClient = KolibriApi.ApiClient.instance;

// Configure HTTP basic authorization: Basic
var Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME'
Basic.password = 'YOUR PASSWORD'

var api = new KolibriApi.ApiApi()

var data = new KolibriApi.Classroom(); // {Classroom} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiAuthClassroomCreate(data, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
KolibriApi.ApiApi apiAuthClassroomCreate POST /api/auth/classroom/
KolibriApi.ApiApi apiAuthClassroomDelete DELETE /api/auth/classroom/{id}/
KolibriApi.ApiApi apiAuthClassroomList GET /api/auth/classroom/
KolibriApi.ApiApi apiAuthClassroomPartialUpdate PATCH /api/auth/classroom/{id}/
KolibriApi.ApiApi apiAuthClassroomRead GET /api/auth/classroom/{id}/
KolibriApi.ApiApi apiAuthClassroomUpdate PUT /api/auth/classroom/{id}/
KolibriApi.ApiApi apiAuthFacilityCreate POST /api/auth/facility/
KolibriApi.ApiApi apiAuthFacilityDelete DELETE /api/auth/facility/{id}/
KolibriApi.ApiApi apiAuthFacilityList GET /api/auth/facility/
KolibriApi.ApiApi apiAuthFacilityPartialUpdate PATCH /api/auth/facility/{id}/
KolibriApi.ApiApi apiAuthFacilityRead GET /api/auth/facility/{id}/
KolibriApi.ApiApi apiAuthFacilityUpdate PUT /api/auth/facility/{id}/
KolibriApi.ApiApi apiAuthFacilitydatasetCreate POST /api/auth/facilitydataset/
KolibriApi.ApiApi apiAuthFacilitydatasetDelete DELETE /api/auth/facilitydataset/{id}/
KolibriApi.ApiApi apiAuthFacilitydatasetList GET /api/auth/facilitydataset/
KolibriApi.ApiApi apiAuthFacilitydatasetPartialUpdate PATCH /api/auth/facilitydataset/{id}/
KolibriApi.ApiApi apiAuthFacilitydatasetRead GET /api/auth/facilitydataset/{id}/
KolibriApi.ApiApi apiAuthFacilitydatasetResetsettings POST /api/auth/facilitydataset/{id}/resetsettings/
KolibriApi.ApiApi apiAuthFacilitydatasetUpdate PUT /api/auth/facilitydataset/{id}/
KolibriApi.ApiApi apiAuthFacilityuserCreate POST /api/auth/facilityuser/
KolibriApi.ApiApi apiAuthFacilityuserDelete DELETE /api/auth/facilityuser/{id}/
KolibriApi.ApiApi apiAuthFacilityuserList GET /api/auth/facilityuser/
KolibriApi.ApiApi apiAuthFacilityuserPartialUpdate PATCH /api/auth/facilityuser/{id}/
KolibriApi.ApiApi apiAuthFacilityuserRead GET /api/auth/facilityuser/{id}/
KolibriApi.ApiApi apiAuthFacilityuserUpdate PUT /api/auth/facilityuser/{id}/
KolibriApi.ApiApi apiAuthFacilityusernameList GET /api/auth/facilityusername/
KolibriApi.ApiApi apiAuthFacilityusernameRead GET /api/auth/facilityusername/{id}/
KolibriApi.ApiApi apiAuthLearnergroupCreate POST /api/auth/learnergroup/
KolibriApi.ApiApi apiAuthLearnergroupDelete DELETE /api/auth/learnergroup/{id}/
KolibriApi.ApiApi apiAuthLearnergroupList GET /api/auth/learnergroup/
KolibriApi.ApiApi apiAuthLearnergroupPartialUpdate PATCH /api/auth/learnergroup/{id}/
KolibriApi.ApiApi apiAuthLearnergroupRead GET /api/auth/learnergroup/{id}/
KolibriApi.ApiApi apiAuthLearnergroupUpdate PUT /api/auth/learnergroup/{id}/
KolibriApi.ApiApi apiAuthMembershipCreate POST /api/auth/membership/
KolibriApi.ApiApi apiAuthMembershipDelete DELETE /api/auth/membership/
KolibriApi.ApiApi apiAuthMembershipDelete_0 DELETE /api/auth/membership/{id}/
KolibriApi.ApiApi apiAuthMembershipList GET /api/auth/membership/
KolibriApi.ApiApi apiAuthMembershipPartialUpdate PATCH /api/auth/membership/{id}/
KolibriApi.ApiApi apiAuthMembershipRead GET /api/auth/membership/{id}/
KolibriApi.ApiApi apiAuthMembershipUpdate PUT /api/auth/membership/{id}/
KolibriApi.ApiApi apiAuthPortalRegister POST /api/auth/portal/register/
KolibriApi.ApiApi apiAuthPortalValidateToken GET /api/auth/portal/validate_token/
KolibriApi.ApiApi apiAuthRoleCreate POST /api/auth/role/
KolibriApi.ApiApi apiAuthRoleDelete DELETE /api/auth/role/
KolibriApi.ApiApi apiAuthRoleDelete_0 DELETE /api/auth/role/{id}/
KolibriApi.ApiApi apiAuthRoleList GET /api/auth/role/
KolibriApi.ApiApi apiAuthRolePartialUpdate PATCH /api/auth/role/{id}/
KolibriApi.ApiApi apiAuthRoleRead GET /api/auth/role/{id}/
KolibriApi.ApiApi apiAuthRoleUpdate PUT /api/auth/role/{id}/
KolibriApi.ApiApi apiAuthSessionCreate POST /api/auth/session/
KolibriApi.ApiApi apiAuthSessionDelete DELETE /api/auth/session/{id}/
KolibriApi.ApiApi apiAuthSessionUpdate PUT /api/auth/session/{id}/
KolibriApi.ApiApi apiAuthSetnonspecifiedpasswordCreate POST /api/auth/setnonspecifiedpassword
KolibriApi.ApiApi apiAuthSignupCreate POST /api/auth/signup/
KolibriApi.ApiApi apiAuthUsernameexistsList GET /api/auth/usernameexists
KolibriApi.ApiApi apiBookmarksBookmarksCreate POST /api/bookmarks/bookmarks/
KolibriApi.ApiApi apiBookmarksBookmarksDelete DELETE /api/bookmarks/bookmarks/{id}/
KolibriApi.ApiApi apiBookmarksBookmarksList GET /api/bookmarks/bookmarks/
KolibriApi.ApiApi apiBookmarksBookmarksPartialUpdate PATCH /api/bookmarks/bookmarks/{id}/
KolibriApi.ApiApi apiBookmarksBookmarksRead GET /api/bookmarks/bookmarks/{id}/
KolibriApi.ApiApi apiBookmarksBookmarksUpdate PUT /api/bookmarks/bookmarks/{id}/
KolibriApi.ApiApi apiContentChannelFilterOptions GET /api/content/channel/filter_options/
KolibriApi.ApiApi apiContentChannelList GET /api/content/channel/
KolibriApi.ApiApi apiContentChannelRead GET /api/content/channel/{id}/
KolibriApi.ApiApi apiContentContentnodeBookmarksList GET /api/content/contentnode_bookmarks/
KolibriApi.ApiApi apiContentContentnodeCopies GET /api/content/contentnode/{id}/copies/
KolibriApi.ApiApi apiContentContentnodeCopiesCount GET /api/content/contentnode/copies_count/
KolibriApi.ApiApi apiContentContentnodeDescendants GET /api/content/contentnode/descendants/
KolibriApi.ApiApi apiContentContentnodeDescendantsAssessments GET /api/content/contentnode/descendants_assessments/
KolibriApi.ApiApi apiContentContentnodeGranularRead GET /api/content/contentnode_granular/{id}/
KolibriApi.ApiApi apiContentContentnodeList GET /api/content/contentnode/
KolibriApi.ApiApi apiContentContentnodeNextContent GET /api/content/contentnode/{id}/next_content/
KolibriApi.ApiApi apiContentContentnodeNextSteps GET /api/content/contentnode/next_steps/ Recommend content that has user completed content as a prerequisite, or leftward sibling.
KolibriApi.ApiApi apiContentContentnodeNodeAssessments GET /api/content/contentnode/node_assessments/
KolibriApi.ApiApi apiContentContentnodePopular GET /api/content/contentnode/popular/ Recommend content that is popular with all users.
KolibriApi.ApiApi apiContentContentnodeRandom GET /api/content/contentnode/random/
KolibriApi.ApiApi apiContentContentnodeRead GET /api/content/contentnode/{id}/
KolibriApi.ApiApi apiContentContentnodeRecommendationsFor GET /api/content/contentnode/{id}/recommendations_for/
KolibriApi.ApiApi apiContentContentnodeResume GET /api/content/contentnode/resume/ Recommend content that the user has recently engaged with, but not finished.
KolibriApi.ApiApi apiContentContentnodeSearchCopies GET /api/content/contentnode_search/{id}/copies/
KolibriApi.ApiApi apiContentContentnodeSearchCopiesCount GET /api/content/contentnode_search/copies_count/
KolibriApi.ApiApi apiContentContentnodeSearchDescendants GET /api/content/contentnode_search/descendants/
KolibriApi.ApiApi apiContentContentnodeSearchDescendantsAssessments GET /api/content/contentnode_search/descendants_assessments/
KolibriApi.ApiApi apiContentContentnodeSearchList GET /api/content/contentnode_search/
KolibriApi.ApiApi apiContentContentnodeSearchNextContent GET /api/content/contentnode_search/{id}/next_content/
KolibriApi.ApiApi apiContentContentnodeSearchNextSteps GET /api/content/contentnode_search/next_steps/ Recommend content that has user completed content as a prerequisite, or leftward sibling.
KolibriApi.ApiApi apiContentContentnodeSearchNodeAssessments GET /api/content/contentnode_search/node_assessments/
KolibriApi.ApiApi apiContentContentnodeSearchPopular GET /api/content/contentnode_search/popular/ Recommend content that is popular with all users.
KolibriApi.ApiApi apiContentContentnodeSearchRandom GET /api/content/contentnode_search/random/
KolibriApi.ApiApi apiContentContentnodeSearchRead GET /api/content/contentnode_search/{id}/
KolibriApi.ApiApi apiContentContentnodeSearchRecommendationsFor GET /api/content/contentnode_search/{id}/recommendations_for/
KolibriApi.ApiApi apiContentContentnodeSearchResume GET /api/content/contentnode_search/resume/ Recommend content that the user has recently engaged with, but not finished.
KolibriApi.ApiApi apiContentContentnodeTreeRead GET /api/content/contentnode_tree/{id}/ A nested, paginated representation of the children and grandchildren of a specific node
KolibriApi.ApiApi apiContentContentnodeprogressList GET /api/content/contentnodeprogress/
KolibriApi.ApiApi apiContentContentnodeprogressTree GET /api/content/contentnodeprogress/{id}/tree/
KolibriApi.ApiApi apiContentFileList GET /api/content/file/
KolibriApi.ApiApi apiContentFileRead GET /api/content/file/{id}/
KolibriApi.ApiApi apiContentRemotechannelKolibriStudioStatus GET /api/content/remotechannel/kolibri_studio_status/
KolibriApi.ApiApi apiContentRemotechannelList GET /api/content/remotechannel/
KolibriApi.ApiApi apiContentRemotechannelRead GET /api/content/remotechannel/{id}/
KolibriApi.ApiApi apiContentRemotechannelRetrieveList GET /api/content/remotechannel/{id}/retrieve_list/
KolibriApi.ApiApi apiContentUsercontentnodeList GET /api/content/usercontentnode/
KolibriApi.ApiApi apiDeviceDeviceinfoList GET /api/device/deviceinfo/
KolibriApi.ApiApi apiDeviceDevicenameList GET /api/device/devicename/
KolibriApi.ApiApi apiDeviceDevicenamePartialUpdate PATCH /api/device/devicename/
KolibriApi.ApiApi apiDeviceDevicepermissionsCreate POST /api/device/devicepermissions/
KolibriApi.ApiApi apiDeviceDevicepermissionsDelete DELETE /api/device/devicepermissions/{user}/
KolibriApi.ApiApi apiDeviceDevicepermissionsList GET /api/device/devicepermissions/
KolibriApi.ApiApi apiDeviceDevicepermissionsPartialUpdate PATCH /api/device/devicepermissions/{user}/
KolibriApi.ApiApi apiDeviceDevicepermissionsRead GET /api/device/devicepermissions/{user}/
KolibriApi.ApiApi apiDeviceDevicepermissionsUpdate PUT /api/device/devicepermissions/{user}/
KolibriApi.ApiApi apiDeviceDeviceprovisionCreate POST /api/device/deviceprovision/
KolibriApi.ApiApi apiDeviceDevicesettingsList GET /api/device/devicesettings/
KolibriApi.ApiApi apiDeviceDevicesettingsPartialUpdate PATCH /api/device/devicesettings/
KolibriApi.ApiApi apiDeviceFreespaceList GET /api/device/freespace/
KolibriApi.ApiApi apiDeviceUsersyncstatusList GET /api/device/usersyncstatus/
KolibriApi.ApiApi apiDeviceUsersyncstatusRead GET /api/device/usersyncstatus/{id}/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationCreate POST /api/discovery/dynamicnetworklocation/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationDelete DELETE /api/discovery/dynamicnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationList GET /api/discovery/dynamicnetworklocation/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationPartialUpdate PATCH /api/discovery/dynamicnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationRead GET /api/discovery/dynamicnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryDynamicnetworklocationUpdate PUT /api/discovery/dynamicnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryNetworklocationCreate POST /api/discovery/networklocation/
KolibriApi.ApiApi apiDiscoveryNetworklocationDelete DELETE /api/discovery/networklocation/{id}/
KolibriApi.ApiApi apiDiscoveryNetworklocationFacilitiesRead GET /api/discovery/networklocation_facilities/{id}/
KolibriApi.ApiApi apiDiscoveryNetworklocationList GET /api/discovery/networklocation/
KolibriApi.ApiApi apiDiscoveryNetworklocationPartialUpdate PATCH /api/discovery/networklocation/{id}/
KolibriApi.ApiApi apiDiscoveryNetworklocationRead GET /api/discovery/networklocation/{id}/
KolibriApi.ApiApi apiDiscoveryNetworklocationUpdate PUT /api/discovery/networklocation/{id}/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationCreate POST /api/discovery/staticnetworklocation/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationDelete DELETE /api/discovery/staticnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationList GET /api/discovery/staticnetworklocation/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationPartialUpdate PATCH /api/discovery/staticnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationRead GET /api/discovery/staticnetworklocation/{id}/
KolibriApi.ApiApi apiDiscoveryStaticnetworklocationUpdate PUT /api/discovery/staticnetworklocation/{id}/
KolibriApi.ApiApi apiExamsExamCreate POST /api/exams/exam/
KolibriApi.ApiApi apiExamsExamDelete DELETE /api/exams/exam/{id}/
KolibriApi.ApiApi apiExamsExamList GET /api/exams/exam/
KolibriApi.ApiApi apiExamsExamPartialUpdate PATCH /api/exams/exam/{id}/
KolibriApi.ApiApi apiExamsExamRead GET /api/exams/exam/{id}/
KolibriApi.ApiApi apiExamsExamUpdate PUT /api/exams/exam/{id}/
KolibriApi.ApiApi apiLessonsLessonCreate POST /api/lessons/lesson/
KolibriApi.ApiApi apiLessonsLessonDelete DELETE /api/lessons/lesson/{id}/
KolibriApi.ApiApi apiLessonsLessonList GET /api/lessons/lesson/
KolibriApi.ApiApi apiLessonsLessonPartialUpdate PATCH /api/lessons/lesson/{id}/
KolibriApi.ApiApi apiLessonsLessonRead GET /api/lessons/lesson/{id}/
KolibriApi.ApiApi apiLessonsLessonUpdate PUT /api/lessons/lesson/{id}/
KolibriApi.ApiApi apiLoggerAttemptlogList GET /api/logger/attemptlog/
KolibriApi.ApiApi apiLoggerAttemptlogRead GET /api/logger/attemptlog/{id}/
KolibriApi.ApiApi apiLoggerMasterylogList GET /api/logger/masterylog/
KolibriApi.ApiApi apiLoggerMasterylogRead GET /api/logger/masterylog/{id}/
KolibriApi.ApiApi apiLoggerTrackprogressCreate POST /api/logger/trackprogress/ Make a POST request to start a content session.
KolibriApi.ApiApi apiLoggerTrackprogressUpdate PUT /api/logger/trackprogress/{id}/ Make a PUT request to update the current session
KolibriApi.ApiApi apiLoggerUserprogressRead GET /api/logger/userprogress/{id}/
KolibriApi.ApiApi apiMorangoV1BuffersCreate POST /api/morango/v1/buffers/
KolibriApi.ApiApi apiMorangoV1BuffersList GET /api/morango/v1/buffers/
KolibriApi.ApiApi apiMorangoV1CertificatechainCreate POST /api/morango/v1/certificatechain/
KolibriApi.ApiApi apiMorangoV1CertificatesCreate POST /api/morango/v1/certificates/
KolibriApi.ApiApi apiMorangoV1CertificatesList GET /api/morango/v1/certificates/
KolibriApi.ApiApi apiMorangoV1CertificatesRead GET /api/morango/v1/certificates/{id}/
KolibriApi.ApiApi apiMorangoV1MorangoinfoRead GET /api/morango/v1/morangoinfo/{id}/
KolibriApi.ApiApi apiMorangoV1NoncesCreate POST /api/morango/v1/nonces/
KolibriApi.ApiApi apiMorangoV1PublickeyList GET /api/morango/v1/publickey/
KolibriApi.ApiApi apiMorangoV1PublickeyRead GET /api/morango/v1/publickey/{id}/
KolibriApi.ApiApi apiMorangoV1SyncsessionsCreate POST /api/morango/v1/syncsessions/
KolibriApi.ApiApi apiMorangoV1SyncsessionsDelete DELETE /api/morango/v1/syncsessions/{id}/
KolibriApi.ApiApi apiMorangoV1SyncsessionsRead GET /api/morango/v1/syncsessions/{id}/
KolibriApi.ApiApi apiMorangoV1TransfersessionsCreate POST /api/morango/v1/transfersessions/
KolibriApi.ApiApi apiMorangoV1TransfersessionsDelete DELETE /api/morango/v1/transfersessions/{id}/
KolibriApi.ApiApi apiMorangoV1TransfersessionsPartialUpdate PATCH /api/morango/v1/transfersessions/{id}/
KolibriApi.ApiApi apiMorangoV1TransfersessionsRead GET /api/morango/v1/transfersessions/{id}/
KolibriApi.ApiApi apiMorangoV1TransfersessionsUpdate PUT /api/morango/v1/transfersessions/{id}/
KolibriApi.ApiApi apiNotificationsPingbacknotificationList GET /api/notifications/pingbacknotification/
KolibriApi.ApiApi apiNotificationsPingbacknotificationRead GET /api/notifications/pingbacknotification/{id}/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedCreate POST /api/notifications/pingbacknotificationdismissed/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedDelete DELETE /api/notifications/pingbacknotificationdismissed/{id}/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedList GET /api/notifications/pingbacknotificationdismissed/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedPartialUpdate PATCH /api/notifications/pingbacknotificationdismissed/{id}/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedRead GET /api/notifications/pingbacknotificationdismissed/{id}/
KolibriApi.ApiApi apiNotificationsPingbacknotificationdismissedUpdate PUT /api/notifications/pingbacknotificationdismissed/{id}/
KolibriApi.ApiApi apiPublicChannelsList GET /api/public/{version}/channels
KolibriApi.ApiApi apiPublicChannelsLookupList GET /api/public/{version}/channels/lookup/(P{identifier}[/]+)
KolibriApi.ApiApi apiPublicFacilityuserList GET /api/public/facilityuser/
KolibriApi.ApiApi apiPublicFacilityuserRead GET /api/public/facilityuser/{id}/
KolibriApi.ApiApi apiPublicInfoList GET /api/public/info/
KolibriApi.ApiApi apiPublicSyncqueueCreate POST /api/public/syncqueue/
KolibriApi.ApiApi apiPublicSyncqueueUpdate PUT /api/public/syncqueue/{id}/
KolibriApi.ApiApi apiPublicV1FacilityList GET /api/public/v1/facility/
KolibriApi.ApiApi apiPublicV1FacilityRead GET /api/public/v1/facility/{id}/
KolibriApi.ApiApi apiTasksFacilitytasksCanceltask POST /api/tasks/facilitytasks/canceltask/
KolibriApi.ApiApi apiTasksFacilitytasksCleartask POST /api/tasks/facilitytasks/cleartask/
KolibriApi.ApiApi apiTasksFacilitytasksCleartasks POST /api/tasks/facilitytasks/cleartasks/
KolibriApi.ApiApi apiTasksFacilitytasksCreate POST /api/tasks/facilitytasks/ Enqueue a task for async processing.
KolibriApi.ApiApi apiTasksFacilitytasksDelete DELETE /api/tasks/facilitytasks/{id}/
KolibriApi.ApiApi apiTasksFacilitytasksDeletefinishedtasks POST /api/tasks/facilitytasks/deletefinishedtasks/
KolibriApi.ApiApi apiTasksFacilitytasksList GET /api/tasks/facilitytasks/
KolibriApi.ApiApi apiTasksFacilitytasksRead GET /api/tasks/facilitytasks/{id}/
KolibriApi.ApiApi apiTasksFacilitytasksRestarttask POST /api/tasks/facilitytasks/restarttask/
KolibriApi.ApiApi apiTasksFacilitytasksStartdataportalbulksync POST /api/tasks/facilitytasks/startdataportalbulksync/
KolibriApi.ApiApi apiTasksFacilitytasksStartdataportalsync POST /api/tasks/facilitytasks/startdataportalsync/
KolibriApi.ApiApi apiTasksFacilitytasksStartdeletefacility POST /api/tasks/facilitytasks/startdeletefacility/
KolibriApi.ApiApi apiTasksFacilitytasksStartpeerfacilityimport POST /api/tasks/facilitytasks/startpeerfacilityimport/
KolibriApi.ApiApi apiTasksFacilitytasksStartpeerfacilitysync POST /api/tasks/facilitytasks/startpeerfacilitysync/
KolibriApi.ApiApi apiTasksTasksCanceltask POST /api/tasks/tasks/canceltask/
KolibriApi.ApiApi apiTasksTasksChanneldiffstats POST /api/tasks/tasks/channeldiffstats/
KolibriApi.ApiApi apiTasksTasksCleartask POST /api/tasks/tasks/cleartask/
KolibriApi.ApiApi apiTasksTasksCleartasks POST /api/tasks/tasks/cleartasks/
KolibriApi.ApiApi apiTasksTasksCreate POST /api/tasks/tasks/ Enqueue a task for async processing.
KolibriApi.ApiApi apiTasksTasksDelete DELETE /api/tasks/tasks/{id}/
KolibriApi.ApiApi apiTasksTasksDeletefinishedtasks POST /api/tasks/tasks/deletefinishedtasks/
KolibriApi.ApiApi apiTasksTasksExportuserstocsv POST /api/tasks/tasks/exportuserstocsv/ Export users, classes, roles and roles assignemnts to a csv file.
KolibriApi.ApiApi apiTasksTasksImportusersfromcsv POST /api/tasks/tasks/importusersfromcsv/
KolibriApi.ApiApi apiTasksTasksList GET /api/tasks/tasks/
KolibriApi.ApiApi apiTasksTasksLocaldrive GET /api/tasks/tasks/localdrive/
KolibriApi.ApiApi apiTasksTasksRead GET /api/tasks/tasks/{id}/
KolibriApi.ApiApi apiTasksTasksRestarttask POST /api/tasks/tasks/restarttask/
KolibriApi.ApiApi apiTasksTasksStartbulkdelete POST /api/tasks/tasks/startbulkdelete/
KolibriApi.ApiApi apiTasksTasksStartchannelupdate POST /api/tasks/tasks/startchannelupdate/
KolibriApi.ApiApi apiTasksTasksStartdeletechannel POST /api/tasks/tasks/startdeletechannel/
KolibriApi.ApiApi apiTasksTasksStartdiskbulkexport POST /api/tasks/tasks/startdiskbulkexport/
KolibriApi.ApiApi apiTasksTasksStartdiskbulkimport POST /api/tasks/tasks/startdiskbulkimport/
KolibriApi.ApiApi apiTasksTasksStartdiskchannelimport POST /api/tasks/tasks/startdiskchannelimport/
KolibriApi.ApiApi apiTasksTasksStartdiskcontentimport POST /api/tasks/tasks/startdiskcontentimport/
KolibriApi.ApiApi apiTasksTasksStartdiskexport POST /api/tasks/tasks/startdiskexport/
KolibriApi.ApiApi apiTasksTasksStartexportlogcsv POST /api/tasks/tasks/startexportlogcsv/ Dumps in csv format the required logs. By default it will be dump contentsummarylog.
KolibriApi.ApiApi apiTasksTasksStartremotebulkimport POST /api/tasks/tasks/startremotebulkimport/
KolibriApi.ApiApi apiTasksTasksStartremotechannelimport POST /api/tasks/tasks/startremotechannelimport/
KolibriApi.ApiApi apiTasksTasksStartremotecontentimport POST /api/tasks/tasks/startremotecontentimport/
KolibriApi.AppApi appApiInitializeRead GET /app/api/initialize/([0-9a-f]{32})
KolibriApi.CoachApi coachApiClasssummaryRead GET /coach/api/classsummary/{id}/
KolibriApi.CoachApi coachApiExercisedifficultiesRead GET /coach/api/exercisedifficulties/{id}/
KolibriApi.CoachApi coachApiLessonreportList GET /coach/api/lessonreport/
KolibriApi.CoachApi coachApiLessonreportRead GET /coach/api/lessonreport/{id}/
KolibriApi.CoachApi coachApiNotificationsCreate POST /coach/api/notifications/
KolibriApi.CoachApi coachApiNotificationsDelete DELETE /coach/api/notifications/{id}/
KolibriApi.CoachApi coachApiNotificationsList GET /coach/api/notifications/
KolibriApi.CoachApi coachApiNotificationsPartialUpdate PATCH /coach/api/notifications/{id}/
KolibriApi.CoachApi coachApiNotificationsRead GET /coach/api/notifications/{id}/
KolibriApi.CoachApi coachApiNotificationsUpdate PUT /coach/api/notifications/{id}/
KolibriApi.CoachApi coachApiQuizdifficultiesRead GET /coach/api/quizdifficulties/{id}/
KolibriApi.DeviceApi deviceApiDeviceChannelList GET /device/api/device_channel/
KolibriApi.DeviceApi deviceApiDeviceChannelRead GET /device/api/device_channel/{id}/
KolibriApi.DeviceApi deviceApiDevicechannelorderCreate POST /device/api/devicechannelorder
KolibriApi.DeviceApi deviceApiImportexportsizeviewCreate POST /device/api/importexportsizeview
KolibriApi.LearnApi learnApiHomehydrateList GET /learn/api/homehydrate
KolibriApi.LearnApi learnApiLearnerclassroomList GET /learn/api/learnerclassroom/
KolibriApi.LearnApi learnApiLearnerclassroomRead GET /learn/api/learnerclassroom/{id}/
KolibriApi.LearnApi learnApiLearnerlessonList GET /learn/api/learnerlesson/
KolibriApi.LearnApi learnApiLearnerlessonRead GET /learn/api/learnerlesson/{id}/
KolibriApi.LearnApi learnApiStateList GET /learn/api/state
KolibriApi.SetupApi setupApiFacilityimportCreatesuperuser POST /setup/api/facilityimport/createsuperuser/
KolibriApi.SetupApi setupApiFacilityimportFacilityadmins GET /setup/api/facilityimport/facilityadmins/
KolibriApi.SetupApi setupApiFacilityimportGrantsuperuserpermissions POST /setup/api/facilityimport/grantsuperuserpermissions/
KolibriApi.SetupApi setupApiFacilityimportListfacilitylearners POST /setup/api/facilityimport/listfacilitylearners/ If the request is done by an admin user it will return a list of the users of the facility
KolibriApi.SetupApi setupApiFacilityimportProvisiondevice POST /setup/api/facilityimport/provisiondevice/
KolibriApi.SetupApi setupApiRestartzeroconfRestart POST /setup/api/restartzeroconf/restart/
KolibriApi.SetupApi setupApiSoudtasksCanceltask POST /setup/api/soudtasks/canceltask/
KolibriApi.SetupApi setupApiSoudtasksChanneldiffstats POST /setup/api/soudtasks/channeldiffstats/
KolibriApi.SetupApi setupApiSoudtasksCleartask POST /setup/api/soudtasks/cleartask/
KolibriApi.SetupApi setupApiSoudtasksCleartasks POST /setup/api/soudtasks/cleartasks/
KolibriApi.SetupApi setupApiSoudtasksCreate POST /setup/api/soudtasks/ Enqueue a task for async processing.
KolibriApi.SetupApi setupApiSoudtasksDelete DELETE /setup/api/soudtasks/{id}/
KolibriApi.SetupApi setupApiSoudtasksDeletefinishedtasks POST /setup/api/soudtasks/deletefinishedtasks/
KolibriApi.SetupApi setupApiSoudtasksExportuserstocsv POST /setup/api/soudtasks/exportuserstocsv/ Export users, classes, roles and roles assignemnts to a csv file.
KolibriApi.SetupApi setupApiSoudtasksImportusersfromcsv POST /setup/api/soudtasks/importusersfromcsv/
KolibriApi.SetupApi setupApiSoudtasksList GET /setup/api/soudtasks/
KolibriApi.SetupApi setupApiSoudtasksLocaldrive GET /setup/api/soudtasks/localdrive/
KolibriApi.SetupApi setupApiSoudtasksRead GET /setup/api/soudtasks/{id}/
KolibriApi.SetupApi setupApiSoudtasksRestarttask POST /setup/api/soudtasks/restarttask/
KolibriApi.SetupApi setupApiSoudtasksStartbulkdelete POST /setup/api/soudtasks/startbulkdelete/
KolibriApi.SetupApi setupApiSoudtasksStartchannelupdate POST /setup/api/soudtasks/startchannelupdate/
KolibriApi.SetupApi setupApiSoudtasksStartdeletechannel POST /setup/api/soudtasks/startdeletechannel/
KolibriApi.SetupApi setupApiSoudtasksStartdiskbulkexport POST /setup/api/soudtasks/startdiskbulkexport/
KolibriApi.SetupApi setupApiSoudtasksStartdiskbulkimport POST /setup/api/soudtasks/startdiskbulkimport/
KolibriApi.SetupApi setupApiSoudtasksStartdiskchannelimport POST /setup/api/soudtasks/startdiskchannelimport/
KolibriApi.SetupApi setupApiSoudtasksStartdiskcontentimport POST /setup/api/soudtasks/startdiskcontentimport/
KolibriApi.SetupApi setupApiSoudtasksStartdiskexport POST /setup/api/soudtasks/startdiskexport/
KolibriApi.SetupApi setupApiSoudtasksStartexportlogcsv POST /setup/api/soudtasks/startexportlogcsv/ Dumps in csv format the required logs. By default it will be dump contentsummarylog.
KolibriApi.SetupApi setupApiSoudtasksStartremotebulkimport POST /setup/api/soudtasks/startremotebulkimport/
KolibriApi.SetupApi setupApiSoudtasksStartremotechannelimport POST /setup/api/soudtasks/startremotechannelimport/
KolibriApi.SetupApi setupApiSoudtasksStartremotecontentimport POST /setup/api/soudtasks/startremotecontentimport/
KolibriApi.SetupApi setupApiTasksCanceltask POST /setup/api/tasks/canceltask/
KolibriApi.SetupApi setupApiTasksCleartask POST /setup/api/tasks/cleartask/
KolibriApi.SetupApi setupApiTasksCleartasks POST /setup/api/tasks/cleartasks/
KolibriApi.SetupApi setupApiTasksCreate POST /setup/api/tasks/ Enqueue a task for async processing.
KolibriApi.SetupApi setupApiTasksDelete DELETE /setup/api/tasks/{id}/
KolibriApi.SetupApi setupApiTasksDeletefinishedtasks POST /setup/api/tasks/deletefinishedtasks/
KolibriApi.SetupApi setupApiTasksList GET /setup/api/tasks/
KolibriApi.SetupApi setupApiTasksRead GET /setup/api/tasks/{id}/
KolibriApi.SetupApi setupApiTasksRestarttask POST /setup/api/tasks/restarttask/
KolibriApi.SetupApi setupApiTasksStartpeerfacilityimport POST /setup/api/tasks/startpeerfacilityimport/

Documentation for Models

Documentation for Authorization

Basic

  • Type: HTTP basic authentication