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
  • Register new user and payment method
  • Enroll user existing users
  1. Orca API

Education/Breakaway

Breakaway Endpoints

Register new user and payment method

POST {{HOST}}api/loneUserRegistration

This endpoint allows you to create a new user and enrolled in a course.

Request Body

Name
Type
Description

token

string

Stripe token

mobile

string

User phone number

plan

number

Type of payment plan

email

string

User email address

last_name

string

User last name

first_name

string

User first name

{ 
 "data" => '',
 "message" => '',
 "errorCode" => NULL,
 "errors" => []
 }
{ 
 "data" => '',
 "message" => 'This user is already enrolled in this course',
 "errorCode" => NULL,
 "errors" => []
 }

Enroll user existing users

POST {{HOST}}api/enrollUser

This endpoint allows you to enroll a user into an existing course

Request Body

Name
Type
Description

plan

number

Type of enrollment plan

token

string

Stripe token

username

string

Username

{ 
 "data" => '',
 "message" => '',
 "errorCode" => NULL,
 "errors" => []
 }
{ 
 "data" => '',
 "message" => 'Breakaway Enroll Partial.ly Error Service',
 "errorCode" => 'E-000A',
 "errors" => []
 }
PreviousCypress TestNextTypeForm WebHook

Last updated 4 years ago