flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

getContacts

Returns a list of student contacts

OnInit
./lib/actions/getContacts.js
OnStartup
-
OnClose
-

Attributes

-

getContact

Returns a specific student contact

OnInit
./lib/actions/getContact.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictForStudentContact

Returns the district for a student contact

OnInit
./lib/actions/getDistrictForStudentContact.js
OnStartup
-
OnClose
-

Attributes

-

getStudentForContact

Returns the student for a student contact

OnInit
./lib/actions/getStudentForContact.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictAdmins

Returns a list of district admins

OnInit
./lib/actions/getDistrictAdmins.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictAdmin

Returns a specific district admin

OnInit
./lib/actions/getDistrictAdmin.js
OnStartup
-
OnClose
-

Attributes

-

getDistricts

Returns a list of districts

OnInit
./lib/actions/getDistricts.js
OnStartup
-
OnClose
-

Attributes

-

getDistrict

Returns a specific district

OnInit
./lib/actions/getDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getAdminsForDistrict

Returns the admins for a district

OnInit
./lib/actions/getAdminsForDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolsForDistrict

Returns the schools for a district

OnInit
./lib/actions/getSchoolsForDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getSectionsForDistrict

Returns the sections for a district

OnInit
./lib/actions/getSectionsForDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictStatus

Returns the status of the district

OnInit
./lib/actions/getDistrictStatus.js
OnStartup
-
OnClose
-

Attributes

-

getStudentsForDistrict

Returns the students for a district

OnInit
./lib/actions/getStudentsForDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getTeachersForDistrict

Returns the teachers for a district

OnInit
./lib/actions/getTeachersForDistrict.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolAdmins

Returns a list of school admins

OnInit
./lib/actions/getSchoolAdmins.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolAdmin

Returns a specific school admin

OnInit
./lib/actions/getSchoolAdmin.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolsForSchoolAdmin

Returns the schools for a school admin

OnInit
./lib/actions/getSchoolsForSchoolAdmin.js
OnStartup
-
OnClose
-

Attributes

-

getSchools

Returns a list of schools

OnInit
./lib/actions/getSchools.js
OnStartup
-
OnClose
-

Attributes

-

getSchool

Returns a specific school

OnInit
./lib/actions/getSchool.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictForSchool

Returns the district for a school

OnInit
./lib/actions/getDistrictForSchool.js
OnStartup
-
OnClose
-

Attributes

-

getSectionsForSchool

Returns the sections for a school

OnInit
./lib/actions/getSectionsForSchool.js
OnStartup
-
OnClose
-

Attributes

-

getStudentsForSchool

Returns the students for a school

OnInit
./lib/actions/getStudentsForSchool.js
OnStartup
-
OnClose
-

Attributes

-

getTeachersForSchool

Returns the teachers for a school

OnInit
./lib/actions/getTeachersForSchool.js
OnStartup
-
OnClose
-

Attributes

-

getSections

Returns a list of sections

OnInit
./lib/actions/getSections.js
OnStartup
-
OnClose
-

Attributes

-

getSection

Returns a specific section

OnInit
./lib/actions/getSection.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictForSection

Returns the district for a section

OnInit
./lib/actions/getDistrictForSection.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolForSection

Returns the school for a section

OnInit
./lib/actions/getSchoolForSection.js
OnStartup
-
OnClose
-

Attributes

-

getStudentsForSection

Returns the students for a section

OnInit
./lib/actions/getStudentsForSection.js
OnStartup
-
OnClose
-

Attributes

-

getTeacherForSection

Returns the primary teacher for a section

OnInit
./lib/actions/getTeacherForSection.js
OnStartup
-
OnClose
-

Attributes

-

getTeachersForSection

Returns the teachers for a section

OnInit
./lib/actions/getTeachersForSection.js
OnStartup
-
OnClose
-

Attributes

-

getStudents

Returns a list of students

OnInit
./lib/actions/getStudents.js
OnStartup
-
OnClose
-

Attributes

-

getStudent

Returns a specific student

OnInit
./lib/actions/getStudent.js
OnStartup
-
OnClose
-

Attributes

-

getContactsForStudent

Returns the contacts for a student

OnInit
./lib/actions/getContactsForStudent.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictForStudent

Returns the district for a student

OnInit
./lib/actions/getDistrictForStudent.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolForStudent

Returns the primary school for a student

OnInit
./lib/actions/getSchoolForStudent.js
OnStartup
-
OnClose
-

Attributes

-

getSectionsForStudent

Returns the sections for a student

OnInit
./lib/actions/getSectionsForStudent.js
OnStartup
-
OnClose
-

Attributes

-

getTeachersForStudent

Returns the teachers for a student

OnInit
./lib/actions/getTeachersForStudent.js
OnStartup
-
OnClose
-

Attributes

-

getTeachers

Returns a list of teachers

OnInit
./lib/actions/getTeachers.js
OnStartup
-
OnClose
-

Attributes

-

getTeacher

Returns a specific teacher

OnInit
./lib/actions/getTeacher.js
OnStartup
-
OnClose
-

Attributes

-

getDistrictForTeacher

Returns the district for a teacher

OnInit
./lib/actions/getDistrictForTeacher.js
OnStartup
-
OnClose
-

Attributes

-

getGradeLevelsForTeacher

Returns the grade levels for sections a teacher teaches

OnInit
./lib/actions/getGradeLevelsForTeacher.js
OnStartup
-
OnClose
-

Attributes

-

getSchoolForTeacher

Retrieves school info for a teacher.

OnInit
./lib/actions/getSchoolForTeacher.js
OnStartup
-
OnClose
-

Attributes

-

getSectionsForTeacher

Returns the sections for a teacher

OnInit
./lib/actions/getSectionsForTeacher.js
OnStartup
-
OnClose
-

Attributes

-

getStudentsForTeacher

Returns the students for a teacher

OnInit
./lib/actions/getStudentsForTeacher.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-