Connectors Reference

Casper365 for Education

Casper365 for Education connector provides access for education based apps to their representative data store.

 

Status: Preview

Tier: Premium

Version: V1

 

Actions:

Name

Summary

CourseGet ([Optional]string course)

Obtain course data using the course name

CoursePost ([Optional]Course course)

Update a course record

LogEndPost ([Optional]string identifier)

Add entry to the data log to indicate a batch process finished

LogStartPost ([Optional]string identifier)

Add entry to the data log to indicate a batch process start

StudentGet ([Optional]string studentId)

Obtain student record

StudentPost ([Optional]Student student)

Update a student record

StudentIsBrowserAppGet ()

Check if student is using PowerApps in browser

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

Course

 

Student

 

 

Actions:

CourseGet

Summary: Obtain course data using the course name

Description: Obtain course data using the course name

 

Syntax:

Casper365forEducation.CourseGet ([Optional]string course)

 

Parameters:

Name

Type

Summary

Required

Related Action

course

string

(The unique name associated with the course)

The unique name associated with the course

False

 

Returns:

          Type:array of (Course)

 

CoursePost

Summary: Update a course record

Description: Update a course record

 

Syntax:

Casper365forEducation.CoursePost ([Optional]Course course)

 

Parameters:

Name

Type

Summary

Required

Related Action

course

Course

 

 

False

 

Returns:

          Type:boolean

 

LogEndPost

Summary: Add entry to the data log to indicate a batch process finished

Description: Add entry to the data log to indicate a batch process start

 

Syntax:

Casper365forEducation.LogEndPost ([Optional]string identifier)

 

Parameters:

Name

Type

Summary

Required

Related Action

identifier

string

(Unique identifier for batch process)

Unique identifier for batch process

False

 

Returns:

 

LogStartPost

Summary: Add entry to the data log to indicate a batch process start

Description: Add entry to the data log to indicate a batch process start

 

Syntax:

Casper365forEducation.LogStartPost ([Optional]string identifier)

 

Parameters:

Name

Type

Summary

Required

Related Action

identifier

string

(Unique identifier for batch process)

Unique identifier for batch process

False

 

Returns:

 

StudentGet

Summary: Obtain student record

Description: Add entry to the data log to indicate a batch process start

 

Syntax:

Casper365forEducation.StudentGet ([Optional]string studentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

studentId

string

(The unique CRSID associated with the student)

The unique CRSID associated with the student

False

 

Returns:

          Type:Student

 

StudentPost

Summary: Update a student record

Description: Update a student record

 

Syntax:

Casper365forEducation.StudentPost ([Optional]Student student)

 

Parameters:

Name

Type

Summary

Required

Related Action

student

Student

 

 

False

 

Returns:

 

StudentIsBrowserAppGet

Summary: Check if student is using PowerApps in browser

Description: Simple function to determine if PowerApps is in web view as this cannot currently be worked out from the app

 

Syntax:

Casper365forEducation.StudentIsBrowserAppGet ()

 

Returns:

          Type:boolean

 


 

Course

Summary:

Description:

 

          Properties:

Name

Type

Summary

audience

string

 

 

courseName

string

 

 

dos

string

 

 

email

string

 

 


 

Student

Summary:

Description:

 

          Properties:

Name

Type

Summary

acadCareer

string

 

 

acadOrgDescr

string

 

 

acadProgram

string

 

 

address1

string

 

 

address2

string

 

 

address3

string

 

 

address4

string

 

 

barcode

string

 

 

birthCountryCode

string

 

 

cellTel

string

 

 

city

string

 

 

collegeAccountNo

number(double)

 

 

country

string

 

 

countryCitizen

string

 

 

countryCitizen2

string

 

 

crsid

string

 

 

degree

string

 

 

dob

string

 

 

dos

string

 

 

dosEmail

string

 

 

dosEmployeeId

string

 

 

email

string

 

 

emailAddr

string

 

 

emailPersonal

string

 

 

endDate

string(date-time)

 

 

enqGrp

string

 

 

firstNames

string

 

 

gradTutor

string

 

 

gradTutorEmail

string

 

 

gradTutorEmployeeId

string

 

 

grp

string

 

 

grpId

string

 

 

homeAddress1

string

 

 

homeAddress2

string

 

 

homeAddress3

string

 

 

homeAddress4

string

 

 

homeAddress5

string

 

 

homeCountry

string

 

 

homePostal

string

 

 

homeState

string

 

 

homeTel

string

 

 

matriculation

string

 

 

mobileTel

string

 

 

nationality

string

 

 

postal

string

 

 

prinSuper

string

 

 

prinSuperEmail

string

 

 

prinSuperEmployeeId

string

 

 

sex

string

 

 

startDate

string(date-time)

 

 

studentFeesClass

string

 

 

studyYear

string

 

 

subject

string

 

 

subjectDescr

string

 

 

superEmail

string

 

 

surname

string

 

 

title

string

 

 

tutor

string

 

 

tutorEmail

string

 

 

tutorEmployeeId

string