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 Description
/announcement/get None Announcement [ ] Retrieves annnouncements.


Announcement

Field Format Available Notes / Values
announcementID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
associateWith string c/r None, Course, Program
associateWithID int c/r Required for Course or Program.
associateWithDetails string r Automatically updated.
Display Until yyyy-mm-dd c/r/u Required if not pinned.
pinned boolean c/r/u
announcementDate yyyy-mm-dd c/r/u Required.
announcementTitle string(250) c/r/u Required.
announcement string c/r/u Assumed to be HTML.
announcementDocumentID int c/r/u Will display download link if provided.
sendNotification boolean c/r Will send email version of announcement
to audience on create.
bulkEmailID int r Automatically populated when notification sent.
ownerUserID int c/r
audienceRoleMask int c/r/u
locationMask long c/r/u
restrictStudentStati boolean c/r/u Only display announcement to select student stati.
Student role must be in audience.
studentStati string c/r/u Pipe delimited (|) list of student stati to restrict announcement to.
deleted boolean r

/course

Add, update and manage courses.

Methods

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

Course

Field Format Available Notes / Values
courseID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
locationID int c/r
locationMask long r Automatically generated.
academicYearID int c/r
termID int c/r 0 if not termed.
status string r Active, Completed,
Cancelled, Locked, Pending
courseCode string(50) c/r
courseName string(100) c/r/u
section string(50) c/r/u
version int r Automatically generated.
courseDescription string c/r/u
courseCapacity int c/r/u
courseHours double c/r/u
courseHoursScheduled double r Calculated automatically.
courseCredits double c/r/u
passingMark double c/r/u As a value between 0-100.
finalMarkType string c/r/u Percentage, LetterGrade,
GradePoint, PassFail, Custom
customGradingScaleID int c/r/u When final mark is 'Custom'.
finalMarkTypeAlt string c/r/u Percentage, LetterGrade,
GradePoint, PassFail, None
excludeFromGPA boolean c/r/u
excludeFromAttendance boolean c/r/u
openEnded boolean c/r/u
attendanceType string c/r/u Standard, Hourly
courseStart yyyy-mm-dd c/r/u
courseEnd yyyy-mm-dd c/r/u
selfEnrol boolean c/r/u
coursePercentageGradeAverage double r Automatically calculated (0-100).
courseGradePointAverage double r Automatically calculated (0-4).
numEnrolled int r Automatically calculated.
numCompleted int r Automatically calculated.
totalTuition double r Automatically calculated.
instructorOneID int c/r/u
instructorOneAccess int c/r/u
instructorTwoID int c/r/u
instructorTwoAccess int c/r/u
instructorThreeID int c/r/u
instructorThreeAccess int c/r/u
instructorFourID int c/r/u
instructorFourAccess int c/r/u
instructorFiveID int c/r/u
instructorFiveAccess int c/r/u
instructorSixID int c/r/u
instructorSixAccess int c/r/u
instructorSevenID int c/r/u
instructorSevenAccess int c/r/u
instructorEightID int c/r/u
instructorEightAccess int c/r/u
instructorNineID int c/r/u
instructorNineAccess int c/r/u
instructorTenID int c/r/u
instructorTenAccess int c/r/u
customField1-5 string(500) c/r/u

/document

Download, upload and manage documents in your account.

Methods

Action Required Returns Description
/document/get None Document [ ] Retrieves document meta-data.
/document/getData documentID String Retrieves document data encoded in Base64.
/document/add documentData
associateWith
associateWithID
fileName
fileMimeType
ownerUserID
locationMask
Document Adds a new document. The documentData should contain the document data encoded as Base64.
/document/getTags None DocumentTag [ ] Retrieves defined document tags.

Document

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

DocumentTag

Field Format Available Notes / Values
documentTagID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
documentTag string(100) c/r/u
deleted boolean c/r/u true, false

/event

Add, edit and manage events.

Methods

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

Event

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

/group

Add, update and manage groups.

Methods

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

Group

Field Format Available Notes / Values
groupID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
groupType string c/r Prospect, Student
groupName string(100) c/r/u
groupDescription string c/r/u
numMembers int r Automatically calculated.
ownerUserID int c/r
readRoleMask int c/r/u
updateRoleMask int c/r/u
locationMask long c/r/u

GroupMember

Field Format Available Notes / Values
groupMemberID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
groupID int c/r
associateWith string c/r Prospect, Student
associateWithID int c/r

/location

Retrieve infomation about locations.

Methods

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

Location

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

/program

Add, update and manage programs.

Methods

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

Program

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

/prospect

Add, update and manage prospect data.

Methods

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

Prospect

Field Format Available Notes / Values
prospectID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
prospectKey string r Automatically generated.
recruiterID int c/r UserID of the assigned recruiter.
prospectRecruiterID int r Reference to ProspectRecruiter object.
locationID int c/r/u Location of this prospect.
locationMask int r Automatically generated.
source string r Automatically assigned.
API, Application, Import, Web
sourceDetails string(100) c/r Details of the source.
If empty, the user's IP is recorded.
namePrefix string c/r/u Mr, Ms, Mrs, Miss
firstName string(50) c/r/u
middleName string(50) c/r/u
lastName string(50) c/r/u
addressOne string(100) c/r/u
addressTwo string(100) c/r/u
city string(50) c/r/u
province string(50) c/r/u Province / State
postalCode string(25) c/r/u PostalCode / Zip
country string(2) c/r/u ISO 3166-1 2 Letter Code
permAddressOne string(100) c/r/u
permAddressTwo string(100) c/r/u
permCity string(100) c/r/u
permProvince string(50) c/r/u Province / State
permPostalCode string(25) c/r/u PostalCode / Zip
permCountry string(2) c/r/u ISO 3166-1 2 Letter Code
phone string(50) c/r/u
phoneUnformatted string r Automatically generated.
Contains only numeric characters.
mobilePhone string(50) c/r/u
workPhone string(50) c/r/u
altPhone string(50) c/r/u
email string(100) c/r/u
gender string c/r/u Male, Female
dateofBirth yyyy-mm-dd c/r/u
internationalStudent boolean c/r/u true, false
leadSource string(200) c/r/u
tag string(100) c/r/u
interested string(100) c/r/u Interested code from interested list.
currentStatus string r Current status of prospect.
currentStatusResult string r Pending, Success, Failure
currentStatusResultDate yyyy-mm-dd r
currentStatusAction string r Next action to take.
currentStatusEventDate yyyy-mm-dd r
currentFollowUpDate yyyy-mm-dd r Automatically calculated.
expectedDate yyyy-mm-dd c/r/d The estimated date of enrolment.
expectedRevenue double c/r/d
expectedRevenueProbability double c/r/d Between 0-100.
expectedRevenueDate yyyy-mm-dd c/r/d
optedIn boolean r Prospected opted into receiving emails.
true, false
optedInDate yyyy-mm-dd r
optedInIP string r
optedInNote string r
optedOut boolean r Prospected opted out of receiving emails.
true, false
optedOutDate yyyy-mm-dd r
optedOutNote string r
customField1-40 string(400) c/r/u


/report

Generate and download reports.

Methods

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

Report

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

/staff

Retrieve infomation about staff.

Methods

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

Staff

Field Format Available Notes / Values
staffID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
locationID int r The location for the staff member..
locationMask long r Automatically generated..
roleMask int r Mask of roles assigned.
locationAccessMask long r Mask of accessible locations.
imageDocumentID int r The DocumentID of the image for this staff.
If 0 then no image has been uploaded.
userID int r
hourClockID int r
status string r Active,Not Active
namePrefix string r Mr, Ms, Mrs, Miss
firstName string r
middleName string r
lastName string r
gender string r Male, Female
addressOne string r
addressTwo string r
city string r
province string r Province / State
postalCode string r PostalCode / Zip
country string r ISO 3166-1 2 Letter Code
phone string r
altPhone string r
dateofBirth yyyy-mm-dd r
email string r
sin string r SIN / SSN / NIN
position string r
emailUserName string r
emailUserPass string r This value is encrpyed for security.
emailIncomingServer string r
emailIncomingPort int r
emailIncomingSSL boolean r
emailOutgoingServer string r
emailOutgoingPassword string r This value is encrypted for security.
emailOutgoingPort int r
emailOutgoingTLS boolean r
emailOutgoingSSL boolean r
emailLeaveCopy boolean r
emailCutoffDate yyyy-mm-dd r Only emails after this date are processed.
sendDailyAgenda boolean r
sendDailyAgendaEmpty boolean r
sendDailyAgendaWeekend boolean r
inbox int r Number of unread emails in inbox.
totalHours double r
customField1-30 string r
deleted boolean r

/student

Add, update and manage student data.

Methods

Action Required Returns Description
/student/get None Student [ ] Retrieves students.

Student

Field Format Available Notes / Values
studentID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
studentKey string r Automatically generated.
advisorID int c/r UserID of the assigned student advisor.
locationID int c/r/u Location of this student.
locationMask int r Automatically generated.
userID int r UserID of this student.
hourClockID int c/r/u The id of the assigned hour clock.
imageDocumentID int r The DocumentID of the image for this student.
If 0 then no image has been uploaded.
imageThumbnail string r Thumbnail of student image.
Base64 encoded, jpeg, 30x45.
studentAssignedID string(100) c/r/u
namePrefix string c/r/u Mr, Ms, Mrs, Miss
firstName string(50) c/r/u
middleName string(50) c/r/u
lastName string(50) c/r/u
addressOne string(100) c/r/u
addressTwo string(100) c/r/u
city string(50) c/r/u
province string(50) c/r/u Province / State
postalCode string(25) c/r/u PostalCode / Zip
country string(2) c/r/u ISO 3166-1 2 Letter Code
permAddressOne string(100) c/r/u
permAddressTwo string(100) c/r/u
permCity string(100) c/r/u
permProvince string(50) c/r/u Province / State
permPostalCode string(25) c/r/u PostalCode / Zip
permCountry string(2) c/r/u ISO 3166-1 2 Letter Code
phone string(50) c/r/u
phoneUnformatted string r Automatically generated.
Contains only numeric characters.
mobilePhone string(50) c/r/u
workPhone string(50) c/r/u
altPhone string(50) c/r/u
email string(100) c/r/u
gender string c/r/u Male, Female
dateofBirth yyyy-mm-dd c/r/u
sin string(25) c/r/u SIN / SSN / NIN depending on country.
internationalStudent boolean c/r/u true, false
emergencyContactOne string(50) c/r/u
emergencyContactOneRelationship string(30) c/r/u
emergencyContactOnePhone string(25) c/r/u
emergencyContactOnePhoneAlt string(25) c/r/u
emergencyContactTwo string(50) c/r/u
emergencyContactTwoRelationship string(30) c/r/u
emergencyContactTwoPhone string(25) c/r/u
emergencyContactTwoPhoneAlt string(25) c/r/u
employer string(50) c/r/u
employerContact string(25) c/r/u
employerAddressOne string(100) c/r/u
employerAddressTwo string(100) c/r/u
employerCity string(50) c/r/u
employerProvince string(50) c/r/u
employerCountry string(2) c/r/u ISO 3166-1 2 Letter Code
employerPostalCode string(25) c/r/u
employerPhone string(50) c/r/u
employerEmail string(100) c/r/u
employerWeb string(100) c/r/u
employerPosition string(100) c/r/u
employerPositionType string c/r/u Full Time, Part Time
employerStartDate date yyyy-mm-dd
employerSalary string(100) c/r/u
currentStatus string r Current status of student.
currentBalance double r
currentPaymentPlanBalance double r
currentFundingBalance double r
currentStudentProgramID int r
currentProgramCode string r
currentProgramName string r
totalCreditsEarned double r
percentageGradeAverage double r
gradePointAverage double r
avgAttendance double r
optedIn boolean r Student opted into receiving emails.
true, false
optedInDate yyyy-mm-dd r
optedInIP string r
optedInNote string r
optedOut boolean r Student opted out of receiving emails.
true, false
optedOutDate yyyy-mm-dd r
optedOutNote string r
customField1-40 string(400) c/r/u
archived boolean r
deleted string r

/template

Add, update and manage templates

Methods

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

Template

Field Format Available Notes / Values
templateID int r Automatically generated.
createdDateTime yyyy-mm-dd hh:mm:ss r Automatically generated.
createdByUserID int r Automatically generated.
lastModifiedDateTime yyyy-mm-dd hh:mm:ss r Automatically updated.
lastModifiedByUserID int r Automatically updated.
pdfTemplateID int c/r/u
templateType string c/r/u Required.
Student, Prospect
templateSize string c/r/u Required.
Letter, Legal, A4, Custom
customWidth double c/r/u Required with 'Custom' template size. In inches.
customHeight double c/r/u Required with 'Custom' template size. In inches.
templateTitle string(100) c/r/u Required.
templateDescription text c/r/u
template text c/r/u
ownerUserID int c/r
readRoleMask int c/r/u
updateRoleMask int c/r/u
locationMask long c/r/u Required.