api

easy to use REST style API allowing integration with other software and projects.

 

Overview

ampEducator gives developers access to a REST style API allowing them to access a large subset of it's features.

Before You Begin

In order to start using the API there are two things which need to be done. Both of them require administrator access to the ampEducator account.

  • You must enable the API under the institution account.
  • You must generate / copy the API key found under the institution account.
  • Keep this key secret and do not share it with anyone.

API Access & Response

To access the api you must make an HTTP request in the following forms:

https://{purl}.ampeducator.com/api/{resource}/{action}?apiKey={apiKey}{parameters}
curl --data "apiKey={apiKey}{parameters}" https://{purl}.ampeducator.com/api/{resource}/{action}
  • purl is the unique identified for the institution
  • resource identifies the section of the application
  • action identifies what is being requested
  • apiKey is the unique secret key for the institution
  • parameters are any additional pieces of data which are required for the action

The application will always respond with a JSON object in the following form:

{"messages": "general": [arrayOfStrings], 
             "warning": [arrayOfStrings],
             "errors":  [arrayOfStrings],
             "withErrors": boolean,
             "totalMessages" 1},
{"action": String},
{"query" : Map},
{"data"  : Object[]}
			
  • messages is an Object will identify whether or not the requested action was successfull along with any response messages
  • action is a String identifying which action was requested
  • query is a Map (String key, String value) containing all the parsed query parameters
  • data contains an array of objects returned by the applcation

Parameters

Each action will expect different parameters.

  • You can pass a parameter in the usual way key=value. For example when requesting a student you might pass something like studentID=123.
  • Since the API allows you to request multiple objects, we've also added a second method to pass parameters. The second method is key_{type}=value where {type} can be found in the table below. Using this you could for example request all students added after a certain date by passing createdDateTime_gt=2016-01-01. This would be interpreted by the application as createdDateTime>'2016-01-01'.
  • Using the second method you could pass the same parameter multiple types e.g. createdDateTime_gt=2016-01-01 and createdDateTime_lt=2016-02-01.
  • Dates are expected to be YYYY-MM-DD format.
  • Times are expected to be HH:MM:SS format.
  • Boolean values can be true/false.

Possible Parameter Types
Type Example Interpreted Notes
eq key_eq=value key=value Equals, the default option.
neq key_neq=value key!=value Not equal to.
gt key_gt=value key>value Greater than.
gte key_gte=value key>=value Greater than or equal to.
lt key_lt=value key<value Less than.
lte key_lte=value key<=value Less than or equal to.
like key_like=value key LIKE %value% Value contains the key.
notLike key_notLike=value key NOT LIKE %value% Value doesn't contains the key.
bwIn key_bwIn=value (key & value) != 0 The value mask contains the key.
bwNotIn key_bwNotIn=value (key & value) = 0 The value mask doesn't contain the key.

The last have been included because ampEducator makes use of role and location masks and these bitwise operations can be helpful in restricting / allowing multiple roles and locations.


Restricted Keys

The following keys are reserved and can be used to control the results returned from the API.

  • orderBy If a field name is provided, the results will be returned ordered by that field.
  • orderDir Possible values are ASC and DESC. Results will be sorted accordingly.
  • limit If a value is provided than the API will only return the requested number of objects.
  • offset When a limit is provided, providing this value will offset the results so that they begin from the given number.

Role & Location Masks

ampEducator uses masks to control access to some objects by role and location.

  • To calculate the role mask for an object you add up the role values for the selected roles. For example, referring to the table below, if you want Recruiter Managers and Recruiters to have access you would use 8+16=24 as the role mask.
  • The process is identical for Locations but the mask values for locations are different for each institution and have to be retrieved using an api call.

Role Mask Values
Role Name Mask Value
Admin 2
Location Admin 4
Recruiter Manager 8
Recruiter 16
Registrar 32
Finance 64
Student Advisor 128
Faculty 256
Front Office 512
Student 1024

Instructor Access Masks

Access to courses can be set per instructor.

  • To calculate the access mask for an instructor you add up the values for the sections you would like the instructor to have access to. For example for an instructor with access to only Gradebook and Attendance you would use 2+64=66.

Instructor Access Values
Course Section Mask Value
Announcements 1
Attendance 2
Course Details 4
Documents 8
Events 16
Grades (Scheme) 32
Gradebook 64
Students 128

Notes & Tips

  • The API will return a maximum of 100 objects per request.
  • The easiest way to debug and to make sure a call is working is by posting the link in your browser. For example, try posting the following in your browser replacing the {purl} and {apiKey} with values specific to your institution. You should immediately see the results from ampEducator.
    http://{purl}.ampeducator.com/api/location/get?apiKey={apiKey}
  • All objects contain a unique id field along with createdDateTime, createdByUserID, lastModifiedByDateTime and lastModifiedByUserID fields. These are always read only.
  • Use the table below to determine when an object field can be set / updated

Field Availability Table
Abbreviation Available Description
c On Create The field can be set when a new object is being added.
r On Read The field can be set to restrict results when getting objects.
u On Update The field can be set when an existing object is being updated.

/announcement

Add, update and manage general, course and program announcements.

Methods

Action Required Returns
/announcement/get
Retrieves annnouncements.
None Announcement [ ]


Announcement

Field Format Notes / Values
announcementID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
associateWith string None, Course, Program
associateWithID int
associateWithDetails string
Display Until yyyy-mm-dd
pinned boolean
announcementDate yyyy-mm-dd
announcementTitle string(250)
announcement string
announcementDocumentID int
bulkEmailID int
ownerUserID int
audienceRoleMask int
locationMask long
restrictStudentStati boolean Only display announcement to select student stati.
Only populated when student role in audience.
studentStati string List of student stati to restrict announcement to. Delimited by |. Only populated when student role in audience.
deleted boolean

/course

Add, update and manage courses.

Methods

Action Required Returns
/course/get
Retrieves courses.
None Course [ ]

Course

Field Format Notes / Values
courseID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
locationID int
locationMask long
academicYearID int
status string
courseCode string(50)
courseName string(100)
section string(50)
version int
courseDescription string
courseCapacity int
courseHours double
courseHoursScheduled double
courseCredits double
passingMark double 0-100
finalMarkType string
customGradingScaleID int When final mark is 'Custom'.
finalMarkTypeAlt string
excludeFromGPA boolean
excludeFromAttendance boolean
openEnded boolean
attendanceType string
courseStart yyyy-mm-dd
courseEnd yyyy-mm-dd
selfEnrol boolean
coursePercentageGradeAverage double
courseGradePointAverage double
numEnrolled int
numCompleted int
totalTuition double
instructorOneID int
instructorOneAccess int
instructorTwoID int
instructorTwoAccess int
instructorThreeID int
instructorThreeAccess int
instructorFourID int
instructorFourAccess int
instructorFiveID int
instructorFiveAccess int
instructorSixID int
instructorSixAccess int
instructorSevenID int
instructorSevenAccess int
instructorEightID int
instructorEightAccess int
instructorNineID int
instructorNineAccess int
instructorTenID int
instructorTenAccess int
customField1-5 string(500)

/document

Download, upload and manage documents in your account.

Methods

Action Required Description
/document/get
Retrieves document meta-data.
None Document [ ]
/document/getData
Retrieves document data encoded in Base64.
documentID string
/document/add
Adds a new document.
AddDocumentForm
Document
/document/getTags
Retrieves defined document tags.
None DocumentTag [ ]

AddDocumentForm

Field Format Notes / Values
associateWith string One of 'None','Course','Staff','Student'
associateWithID int Required when associateWith is not None.
fileName string
fileMimeType string
fileDescription string
readRoleMask int If associateWith is None, sum of role masks which can read this document.
updateRoleMask int If associateWith is None, sum of role masks which can update this document.
locationMask int If associateWith is None, sum of locations masks which can access this document.
documentData string The document data encoded in Base64

Document

Field Format Notes / Values
documentID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
associateWith string
associateWithID int 0 (None) or the id of the associated object.
documentTagID int 0 (None) or the id of the document tag.
fileName string
fileSize double Given in kilobytes.
fileMimeType string
fileDescription string
fileExtension string
filePath string
internal boolean
ownerUserID int
readRoleMask int
updateRoleMask int
locationMask int

DocumentTag

Field Format Notes / Values
documentTagID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
documentTag string(100)
deleted boolean

/event

Add, edit and manage events.

Methods

Action Required Returns
/event/get
Retrieves events.
None Event [ ]

Event

Field Format Notes / Values
eventID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
sequence int
Sequentially updated on change.
associateWith string None, Prospect, Student
associateWithID int 0 (None) or the id of the associated object.
associateWithStatusID int
eventType string Meeting, Phone Call In,
Phone Call Out, To Do, Other
eventDescription string
eventAllDay boolean
eventDate yyyy-mm-dd
eventStart yyyy-mm-dd hh:mm:ss
eventEnd yyyy-mm-dd hh:mm:ss
resourceID int
completed boolean
completedByUserID int
completedDateTime yyyy-mm-dd hh:mm:ss
ownerUserID int
readRoleMask int For 'Other' event type.
publicEvent boolean For 'Other' event type.
locationMask int For 'Other' event type.
attendeeOneID
attendeeTwoID
attendeeThreeID
attendeeFourID
attendeeFiveID
attendeeSixID
attendeeSevenID
attendeeEightID
attendeeNineID
attendeeTenID
int For 'Meeting' event type.
deleted boolean

/group

Add, update and manage groups.

Methods

Action Required Returns
/group/get
Retrieves groups.
None Group [ ]
/group/getMembers
Retrieves group members.
groupID GroupMember [ ]

Group

Field Format Notes / Values
groupID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
groupName string(100)
groupDescription string
numMembers int
ownerUserID int
readRoleMask int
updateRoleMask int
locationMask long

GroupMember

Field Format Notes / Values
groupMemberID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
groupID int
studentID int

/location

Retrieve infomation about locations.

Methods

Action Required Returns
/location/get
Retrieves locations.
None Location [ ]

Location

Field Format Notes / Values
locationID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
locationMask int
status string 'Active','Disabled'
name string
contactPerson string
contactPersonPosition string
addressOne string
addressTwo string
city string
province string Province / State
postalCode string PostalCode / Zip
country string ISO 3166-1 2 Letter Code
phone string
fax string
email string
deleted boolean

/program

Add, update and manage programs.

Methods

Action Required Returns
/program/get
Retrieves programs.
None Program [ ]

Program

Field Format Notes / Values
programID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
status string Active, Inactive
version int
programCode string(50)
programName string(100)
programHours double
programWeeks int
programFormat string FullTime, PartTime
passingMark double 0-100
crendentialCode string(20)
credential string
finalMarkType string Percentage, LetterGrade,
GradePoint, PassFail, Custom
customGradingScaleID int When final mark is 'Custom'.
finalMarkTypeAlt string Percentage, LetterGrade,
GradePoint, PassFail, None
totalProgramCredits double
notes string

/prospect

Add, update and manage prospect data.

Methods

Action Required Returns
/prospect/get
Retrieves prospects.
None Student [ ]

/report

Generate and download reports.

Methods

Action Required Returns
/report/get
Retrieves reports.
None Report [ ]

Report

Field Format Notes / Values
reportID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
reportDocumentID int
status string None, Running, Completed, Error
lastRun yyyy-mm-dd hh:mm:ss
reportName string(100)
reportDescription text
reportJRXML string
scheduleType string None,Daily,Weekly,Monthly
scheduleWeekdays int
Bitmask Values
MON1
TUE2
WED4
THU8
FRI16
SAT32
SUN64
scheduleMonthly int 1-28
emailResults boolean
emailUserID int
emailUserTwoID int
emailCC string(500) Emails (CSV)
associateWithLinkType string None,Student
associateReportParameterID int
log text
readRoleMask int
updateRoleMask int
locationMask long

/staff

Retrieve infomation about staff.

Methods

Action Required Returns
/staff/get
Retrieves staff.
None Staff [ ]

Staff

Field Format Notes / Values
staffID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
locationID int
locationMask long
roleMask int Mask of roles assigned.
locationAccessMask long Mask of accessible locations.
imageDocumentID int The DocumentID of the image for this staff.
If 0 then no image has been uploaded.
userID int
hourClockID int
status string Active,Not Active
namePrefix string Mr, Ms, Mrs, Miss
firstName string
middleName string
lastName string
gender string Male,Female
addressOne string
addressTwo string
city string
province string Province / State
postalCode string PostalCode / Zip
country string ISO 3166-1 2 Letter Code
phone string
altPhone string
dateofBirth yyyy-mm-dd
email string
sin string SIN / SSN / NIN
position string
sendDailyAgenda boolean
inbox int Number of unread emails in inbox.
totalHours double
customField1-30 string
deleted boolean

/student

Add, update and manage student data.

Methods

Action Required Returns
/student/add
Adds a new student.
AddStudentForm Student
/student/get
Retrieves students.
None Student [ ]
/student/updateAdmin
Updates admin information for a student.
EditStudentAdministrativeForm Student
/student/updateCustom
Updates custom fields for a student.
EditStudentCustomFieldForm Student
/student/updateDetails
Updates basic information for a student.
EditStudentDetailsForm Student
/student/updateEducation
Updates education information for a student.
EditStudentEducationForm Student
/student/updateEmergencyContacts
Updates emergency contacts for a student.
EditStudentEmergencyContactsForm Student
/student/updateEmployer
Updates employer information for a student.
EditStudentEmployerForm Student
/student/updateOther
Updates other misc information for a student.
EditStudentOtherForm Student
/student/addStatus
Adds a new status for the student.
AddStudentStatusForm StudentStatus

AddStudentForm

Field Format Notes / Values
namePrefix string Mr, Ms, Mrs, Miss
name string(150) Required.
phone string(50)
email string(100) Required. Must be unique.
dateofBirth yyyy-mm-dd
overrideStudentAssignedID booelan If true you must provide a student ID.
studentAssignedID string(100) Required if override is set to true. Must be unique.
locationID int Location of this student. Required.
status string Current status of student. If not provided the default status is used.
advisorID int The user ID for this student's advisor.
agentID int The user ID for this student's agent.
tag string Repeat for multiple tags.
leadSourceCode string
interested string The interested code for any courses or programs. Must be a valid interested code. Repeat for multiple interests.
emailLoginInfo boolean If true the student will receive an email with their login information.

EditStudentAdministrativeForm

Field Format Notes / Values
studentID int Required.
studentAssignedID string Required. Must be unique.
locationIDChanged boolean
locationID int Required if locationIDChanged is true changed.
recruiterIDChanged boolean Only applicable if student type is 'Prospect'.
recruiterID int Required if recruiterIDChanged is true.
Only applicable if student type is 'Prospect'.
advisorIDChanged boolean Only applicable if student type is 'Student'.
advisorID int Required if advisorIDChanged is true.
Only applicable if student type is 'Student'.
agentIDChanged boolean
agentID int Required if agentIDChanged is true.

EditStudentCustomFieldForm

Field Format Notes / Values
studentID int Required.
customField1-100 string(500) Every custom field is updated. Date custom fields must have the form 'yyyy-mm-dd'.

EditStudentDetailsForm

Field Format Notes / Values
studentID int Required.
namePrefix string Mr, Ms, Mrs, Miss
firstName string(50) Required.
middleName string(50)
lastName string(50)
addressOne string(100)
addressTwo string(100)
city string(50)
province string(50) Province / State
postalCode string(25) PostalCode / Zip
country string(2) ISO 3166-1 2 Letter Code
permAddressOne string(100)
permAddressTwo string(100)
permCity string(100)
permProvince string(50) Province / State
permPostalCode string(25) PostalCode / Zip
permCountry string(2) ISO 3166-1 2 Letter Code
phone string(50)
mobilePhoneCountry string(2) ISO 3166-1 2 Letter Code.
Required if mobile phone is present.
mobilePhone string(50)
workPhone string(50)
altPhone string(50)
email string(100) Required.
secondaryEmail string(100)
gender string If set, must be one of 'Male', 'Female', 'TG', 'Other'.
dateofBirth yyyy-mm-dd
sin string(25) SIN / SSN / NIN depending on country.


EditStudentEducationForm

Field Format Notes / Values
studentID int Required.
educationHighSchoolGraduate boolean
educationHighSchoolGraduationYear yyyy Required if educationHighSchoolGraduate is true.
educationHighSchoolName string(50)
educationHighSchoolNotes string
educationPostSecondaryOne boolean
educationPostSecondaryOneName string(50) Required if educationPostSecondaryOne is true.
educationPostSecondaryOneFrom yyyy-mm-dd
educationPostSecondaryOneTo yyyy-mm-dd
educationPostSecondaryOneCredential boolean
educationPostSecondaryOneCredentialType string Required if educationPostSecondaryOneCredential is true. One of 'Certificate', 'Diploma', 'Bachelors', 'Masters', 'Doctorate', 'Other'
educationPostSecondaryOneNotes string
educationPostSecondaryTwo boolean
educationPostSecondaryTwoName string(50) Required if educationPostSecondaryTwo is true.
educationPostSecondaryTwoFrom yyyy-mm-dd
educationPostSecondaryTwoTo yyyy-mm-dd
educationPostSecondaryTwoCredential boolean
educationPostSecondaryTwoCredentialType string(15) Required if educationPostSecondaryTwoCredential is true. One of 'Certificate', 'Diploma', 'Bachelors', 'Masters', 'Doctorate', 'Other'
educationPostSecondaryTwoNotes string

EditStudentEmergencyContactsForm

Field Format Notes / Values
studentID int Required.
emergencyContactOne string(50)
emergencyContactOneRelationship string Required if contact one is populated. Must be one of 'Friend', 'Grandparent', 'Parent', 'Sibling', 'Signifigant Other', 'Spouse', 'Other'
emergencyContactOnePhone string(25) Required if contact one is populated.
emergencyContactOnePhoneAlt string(25)
emergencyContactTwo string(50)
emergencyContactTwoRelationship string Required if contact two is populated. Must be one of 'Friend', 'Grandparent', 'Parent', 'Sibling', 'Signifigant Other', 'Spouse', 'Other'
emergencyContactTwoPhone string(25) Required if contact two is populated.
emergencyContactTwoPhoneAlt string(25)

EditStudentEmployerForm

Field Format Notes / Values
studentID int Required.
employer string(50)
employerContact string(25)
employerAddressOne string(100)
employerAddressTwo string(100)
employerCity string(50)
employerProvince string(50)
employerCountry string(2) ISO 3166-1 2 Letter Code
employerPostalCode string(25)
employerPhone string(50)
employerEmail string(100)
employerWeb string(100)
employerPosition string(100)
employerPositionType string If set, must be one of 'Full Time', 'Part Time'
employerStartDate date yyyy-mm-dd
employerSalary string(100)

EditStudentOtherForm

Field Format Notes / Values
studentID int Required.
feeClassCode string Required. Must be a valid defined fee class code.
internationalStudent boolean
hourClockID int The hour clock ID for this student.
leadSourceCode string If defined, must be a valid lead source code.
tag string Repeat for multiple tags.
interested string Repeat for multiple interested programs / courses. Must be a valid interested code.
expectedDate yyyy-mm-dd
expectedRevenue double
expectedRevenueProbability double 0-100
expectedRevenueDate yyyy-mm-dd

Student

Field Format Notes / Values
studentID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
studentType string 'Prospect','Student','Duplicate'
advisorID int UserID of the assigned student advisor.
locationID int Location of this student.
userID int UserID of this student.
hourClockID int The id of the assigned hour clock.
imageDocumentID int The DocumentID of the image for this student.
If 0 then no image has been uploaded.
imageThumbnail string Thumbnail of student image.
Base64 encoded, jpeg, 30x45.
studentAssignedID string(100)
source string API, Application,Form,Import,Moodle,Public Form,Web
sourceDetails string(100) Details of the source.
namePrefix string Mr, Ms, Mrs, Miss
firstName string(50)
middleName string(50)
lastName string(50)
addressOne string(100)
addressTwo string(100)
city string(50)
province string(50) Province / State
postalCode string(25) PostalCode / Zip
country string(2) ISO 3166-1 2 Letter Code
permAddressOne string(100)
permAddressTwo string(100)
permCity string(100)
permProvince string(50) Province / State
permPostalCode string(25) PostalCode / Zip
permCountry string(2) ISO 3166-1 2 Letter Code
phone string(50)
mobilePhone string(50)
workPhone string(50)
altPhone string(50)
email string(100)
secondaryEmail string(100)
gender string
dateofBirth yyyy-mm-dd
sin string(25) SIN / SSN / NIN depending on country.
internationalStudent boolean true, false
feeClassCode string
leadSourceCategoryCode string
leadSourceCode string
interested string Delimited by |
tag string Delimited by |
baseHours double
expectedDate yyyy-mm-dd
expectedRevenue double
expectedRevenueProbability double 0-100
expectedRevenueDate yyyy-mm-dd
educationHighSchoolGraduate boolean
educationHighSchoolGraduationYear yyyy
educationHighSchoolName string(50)
educationHighSchoolNotes string
educationPostSecondaryOne boolean
educationPostSecondaryOneName string(50)
educationPostSecondaryOneFrom yyyy-mm-dd
educationPostSecondaryOneTo yyyy-mm-dd
educationPostSecondaryOneCredential boolean
educationPostSecondaryOneCredentialType string(15)
educationPostSecondaryOneNotes string
educationPostSecondaryTwo boolean
educationPostSecondaryTwoName string(50)
educationPostSecondaryTwoFrom yyyy-mm-dd
educationPostSecondaryTwoTo yyyy-mm-dd
educationPostSecondaryTwoCredential boolean
educationPostSecondaryTwoCredentialType string(15)
educationPostSecondaryTwoNotes string
emergencyContactOne string(50)
emergencyContactOneRelationship string(30)
emergencyContactOnePhone string(25)
emergencyContactOnePhoneAlt string(25)
emergencyContactTwo string(50)
emergencyContactTwoRelationship string(30)
emergencyContactTwoPhone string(25)
emergencyContactTwoPhoneAlt string(25)
employer string(50)
employerContact string(25)
employerAddressOne string(100)
employerAddressTwo string(100)
employerCity string(50)
employerProvince string(50)
employerCountry string(2) ISO 3166-1 2 Letter Code
employerPostalCode string(25)
employerPhone string(50)
employerEmail string(100)
employerWeb string(100)
employerPosition string(100)
employerPositionType string Full Time, Part Time
employerStartDate date yyyy-mm-dd
employerSalary string(100)
currentStatus string Current status of student.
currentStatusResult string Pending, Success, Failure
currentStatusResultDate yyyy-mm-dd
currentStatusAction string Next action to take.
currentStatusEventDate yyyy-mm-dd
currentFollowUpDate yyyy-mm-dd
currentProgramCode string
currentProgramName string
totalCreditsEarned double
percentageGradeAverage double
gradePointAverage double
avgAttendance double
optedIn boolean Student opted into receiving emails.
true, false
optedInDate yyyy-mm-dd
optedInIP string
optedInNote string
optedOut boolean Student opted out of receiving emails.
true, false
optedOutDate yyyy-mm-dd
optedOutNote string
customField1-100 string(400)
deleted boolean

AddStudentStatusForm

Field Format Notes / Values
studentID int Required.
status string Required. The new status.
note string

Student Status

Field Format Notes / Values
studentStatusID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
studentID int Required.
eventID int
status string
result string
reason string
note string

/template

Add, update and manage templates

Methods

Action Required Returns
/template/get
Retrieves templates.
None Template [ ]

Template

Field Format Notes / Values
templateID int
createdDateTime yyyy-mm-dd hh:mm:ss
createdByUserID int
lastModifiedDateTime yyyy-mm-dd hh:mm:ss
lastModifiedByUserID int
pdfTemplateID int
templateSize string Letter, Legal, A4, Custom
customWidth double With 'Custom' template size. In inches.
customHeight double With 'Custom' template size. In inches.
templateTitle string(100) Required.
templateDescription text
template text
ownerUserID int
readRoleMask int
updateRoleMask int
locationMask long