Skip to content

Instantly share code, notes, and snippets.

@Renddslow

Renddslow/learn-api.md

Last active June 30, 2022 04:01
Show Gist options
  • Save Renddslow/7b7bf4dd861fe732ff5bd517d8c356a3 to your computer and use it in GitHub Desktop.
Save Renddslow/7b7bf4dd861fe732ff5bd517d8c356a3 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
learn-api.md

27 methods completed, 61 to go 30% complete

Course

9 methods completed, 3 to go 75% complete

  • GET /json/learner/courses -> index
  • GET /json/learner/courses/{course} -> show
  • GET /json/user/courses -> courses
  • POST /json/courses -> create
  • PUT /json/courses/reorder -> reorder
  • PUT /json/courses/{courseId} -> update
  • DELETE /json/courses/{courseId} -> delete
  • PATCH /json/courses/{courseId} -> patch
  • POST /json/courses/{courseId}/publish -> publish
  • POST /json/courses/{courseId}/unpublish -> unpublish
  • POST /json/courses/from-course/{courseId} -> createFromCourse
  • POST /json/courses/from-template/{templateId} -> createFromTemplate

Units

7 methods completed 100% complete

  • GET /json/courses/{course}/units -> index
  • GET /json/user/courses/{course}/units -> units
  • GET /json/courses/{course}/units/{unit} -> show
  • POST /json/courses/{course}/units -> create
  • PUT /json/courses/{course}/units/reorder -> reorder
  • PUT /json/courses/{course}/units/{unit} -> update
  • DELETE /json/courses/{course}/units/{unit} -> remove

Pages

10 to go 0% complete

  • GET /json/courses/{course}/pages -> index
  • GET /json/courses/{course}/pages/{page} -> show
  • GET /json/user/courses/{course}/pages -> pages
  • GET /json/user/courses/{course}/pages/{page} -> page
  • GET /json/courses/{course}/pages/{page} -> show
  • POST /json/courses/{course}/pages -> create
  • POST /json/courses/{course}/pages/from-page/{page} -> createFromPage
  • PUT /json/courses/{course}/pages/reorder -> reorder
  • PUT /json/courses/{course}/pages/{page} -> update
  • DELETE /json/courses/{course}/pages/{page} -> remove

Blocks

11 methods completed 100% complete

  • GET /courses/{course}/blocks -> index
  • POST /courses/{course}/blocks -> create
  • PUT /courses/{course}/blocks/reorder -> reorder
  • PUT /courses/{course}/blocks/{block} -> update
  • DELETE /courses/{course}/blocks/{block} -> remove
  • GET /courses/{course}/pages/{page}/blocks -> index
  • POST /courses/{course}/pages/{page}/blocks -> create
  • PUT /courses/{course}/pages/{page}/blocks/reorder -> reorder
  • PUT /courses/{course}/pages/{page}/blocks/{block} -> update
  • DELETE /courses/{course}/pages/{page}/blocks/{block} -> remove
  • POST /courses/{course}/pages/{page}/blocks/{block}/answer -> answer

Profile

3 to go 0% complete

  • GET /json/profile -> show
  • DELETE /json/profile -> remove
  • DELETE /json/profiles/{profileId} -> removePrivileged

Org

9 to go 0% complete

  • GET /json/org -> show
  • PUT /json/org -> update
  • POST /json/orgs -> create
  • GET /json/org/landing -> show
  • PUT /json/org/landing -> update
  • GET /json/org/publisher -> show
  • GET /json/org/users/invite/{code} -> viewInvite
  • POST /json/org/users/invite/{code}/accept -> acceptInvite
  • DELETE /json/org/users/invite/{code} -> dismissInvite

Users

11 to go 0% complete

  • GET /json/users -> index
  • GET /json/users/{userId} -> show
  • PUT /json/users/{userId} -> update
  • GET /json/users/email/search -> emailSearch
  • GET /json/users/{userId}/role -> role
  • PUT /json/users/{userId}/role -> putRole
  • POST /json/org/users/invite -> invite
  • POST /json/org/invites/batch -> inviteMany
  • GET /json/user
  • PUT /json/user -> update
  • DELETE /json/user -> delete

Auth

4 to go 0% complete

  • POST /json/auth/user/verify -> verify
  • POST /json/auth/user/cancel -> cancel
  • GET /json/user/orgs -> index
  • GET /json/auth/reset-password

Bible

2 to go 0% complete

  • GET /json/bible/query/{translation}/{query} -> query
  • GET /json/bible/translations -> translations

Video

2 to go 0% complete

  • GET /json/videos/{video} -> show
  • GET /json/videos -> index

Handouts

6 to go 0% complete

  • GET /courses/{course}/handouts -> index
  • POST /courses/{course}/handouts/{handout}/file -> updateFile
  • POST /courses/{course}/handouts -> create
  • PUT /courses/{course}/handouts/reorder -> reorder
  • PUT /courses/{course}/handouts/{handout} -> update
  • DELETE /courses/{course}/handouts/{handout} -> remove

Course Categories

6 to go 0% complete

  • GET /json/course-categories -> show
  • GET /json/course-categories/{category} -> show
  • POST /json/course-categories -> create
  • PUT /json/course-categories/reorder -> reorder
  • PUT /json/course-categories/{courseCategory} -> update
  • DELETE /json/course-categories/{courseCategory} -> delete

Media

2 to go 0% complete

  • POST /json/media -> create
  • GET /json/media -> get

Misc

1 to go 0% complete

  • GET /json/templates -> show

Superadmins

2 to go 0% complete

  • GET /json/admin/users -> index
  • GET /json/admin/orgs -> index
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment