Dev Docs
  • Introduction
  • Becoming an ORCA Developer
  • Why Sign Up?
  • Developer Resources
  • Understanding Service Apps
  • How to Create a Service App for the ORCA Marketplace
  • Available Permissions
  • How to Request Permissions for a Service App
  • Happy Hours Admin
    • Happy Hours Admin
  • Cyress Tests
    • Cypress Test
  • Orca API
    • Education/Breakaway
    • TypeForm WebHook
    • getOrcaVideoList
    • getPremiumCourses
    • getCourseUsers
    • getDashBoardHeroStatistics
    • getUserProgress
    • Remove CE Credit
    • Add CE Credit
  • TypeForm
    • Setup a webHook on TypeForm
  • Database Migrations
    • MySQL Import Data using Laravel Seeds.
Powered by GitBook
On this page
  1. Orca API

getOrcaVideoList

Get orca videos giving the username and course

Get Orca videos details list

POST {{HOST}}/api/getOrcaVideoList

This endpoint allows you to get free cakes.

Request Body

Name
Type
Description

is_not_completed

boolean

Set true if you need only the uncompleted videos.(By default is set as false)

video_limit

number

Record limit( by default are 6)

{
    "data": {
        "course": [
            {
                "module_id": "3",
                "name": "Lesson 1",
                "track_time_percent": "99.39",
                "shortdescription": null,
                "intro": "",
                "videolength": "490",
                "secondtrack": "487",
                "timecreated": "1589220760",
                "course": "2",
                "thumbnail_url": "http://chilemoodle.orcasandbox.com/pluginfile.php/32/mod_orcavideo/thumbnail/874873013/Mask%20Group%20146.png",
                "videoUrl": "/mod/orcavideo/view.php?id=15"
            },
            {
                "module_id": "24",
                "name": "test666",
                "track_time_percent": "96.73",
                "shortdescription": "",
                "intro": "",
                "videolength": "490",
                "secondtrack": "474",
                "timecreated": "1591722767",
                "course": "2",
                "thumbnail_url": "http://chilemoodle.orcasandbox.com/pluginfile.php/63/mod_orcavideo/thumbnail/209163385/filemoodle1.png",
                "videoUrl": "/mod/orcavideo/view.php?id=15"
            }
        ]
    },
    "message": "",
    "errorCode": "",
    "errors": []
}
{
    "data": [],
    "message": "Missing required field username or course name",
    "errorCode": "",
    "errors": [
        "Missing user or none is logged",
        "The user is not enrolled in a course yet"
    ]
}

PreviousTypeForm WebHookNextgetPremiumCourses

Last updated 4 years ago