Type Definitions
object
# AccountResponse
Response Object of GetAccount endpoint
Properties:
| Name | Type | Description |
|---|---|---|
accountId |
string
|
|
balance |
number
|
|
compassPersonId |
string
|
|
firstName |
string
|
|
imageUrl |
string
|
|
isWalletEnabled |
boolean
|
|
lastName |
string
|
|
name |
string
|
|
schoolId |
string
|
|
userBaseRole |
number
|
|
userId |
number
|
|
userStatus |
number
|
|
username |
string
|
|
yearLevelId |
number
|
object
# Attachments
Child Object of LearningTask
Properties:
| Name | Type | Description |
|---|---|---|
contentUrl |
string
|
|
fileName |
string
|
|
id |
string
|
|
name |
string
|
|
wikiNodeId |
number
|
|
wikiNodeType |
number
|
object
# CalendarEvent
Child Object of CalendarResponse
Properties:
| Name | Type | Description |
|---|---|---|
activityId |
number
|
|
allDay |
boolean
|
|
attendanceMode |
number
|
|
attendeeUserId |
number
|
|
backgroundColor |
string
|
|
description |
string
|
|
finish |
string
|
|
guid |
string
|
|
inClassStatus |
boolean
|
|
instanceId |
number
|
|
learningTaskId |
number
|
|
lessonPlanConfigured |
boolean
|
|
longTitle |
string
|
|
longTitleWithoutTime |
string
|
|
managerId |
number
|
|
managers |
Array.<Manager>
|
|
period |
string
|
|
rollMarked |
boolean
|
|
runningStatus |
number
|
|
start |
string
|
|
targetStudentId |
number
|
|
teachingDaysOnly |
boolean
|
|
textColor |
string
|
|
title |
string
|
|
locations |
Array.<any>
|
object
# CalendarRequest
Request Object for GetCalendarEventsByUser endpoint
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
userId |
number
|
||
startDate |
string
|
"yyyy-mm-dd" |
|
endDate |
string
|
"yyyy-mm-dd" |
|
page |
number
|
<optional> |
|
start |
number
|
<optional> |
|
limit |
number
|
<optional> |
|
homePage |
boolean
|
<optional> |
|
activityId |
number
|
<optional> |
|
locationId |
number
|
<optional> |
|
staffIds |
Array.<number>
|
<optional> |
object
# Comments
Child Object of Student
Properties:
| Name | Type | Description |
|---|---|---|
comment |
string
|
|
id |
number
|
|
status |
number
|
|
taskStudentId |
number
|
|
timestamp |
string
|
|
userIdPoster |
number
|
|
userNamePoster |
string
|
object
# LearningTask
Child Object of LearningTaskResponse
Properties:
| Name | Type | Description |
|---|---|---|
activityId |
number
|
|
activityName |
string
|
|
activityStart |
string
|
|
attachments |
Array.<Attachments>
|
|
canEditResults |
boolean
|
|
canManage |
boolean
|
|
categoryId |
number
|
|
createdTimestamp |
string
|
|
description |
string
|
|
displayPrimaryGrading |
boolean
|
|
distributionType |
number
|
|
dueDateTimestamp |
string
|
|
groupName |
string
|
|
hidden |
boolean
|
|
id |
number
|
|
important |
boolean
|
|
includeBreakdownHeading |
boolean
|
|
includeInOverall |
boolean
|
|
includeInSemesterReports |
boolean
|
|
includeTitleOnSummaryVertical |
boolean
|
|
isAggregateTask |
boolean
|
|
isContributingTask |
boolean
|
|
name |
string
|
|
showTaskDueDates |
boolean
|
|
students |
Array.<Student>
|
|
subjectName |
string
|
|
taskReportDescription |
string
|
|
taskTitleOnReport |
string
|
|
verticalBreakdownHeadings |
boolean
|
|
wikiNodeId |
number
|
object
# LearningTaskActivityIdRequest
Request Object of GetAllLearningTasksByActivityId endpoint
Properties:
| Name | Type | Description |
|---|---|---|
showHiddenTasks |
boolean
|
|
limit |
number
|
|
activityId |
number
|
object
# LearningTaskResponse
Response Object of GetAllLearningTasksBy* endpoint
Properties:
| Name | Type | Description |
|---|---|---|
data |
Array.<LearningTask>
|
|
total |
number
|
object
# LearningTaskUserIdRequest
Request Object of GetAllLearningTasksByUserId endpoint
Properties:
| Name | Type | Description |
|---|---|---|
showHiddenTasks |
boolean
|
|
limit |
number
|
|
userId |
number
|
object
# LessonPlan
Child Object of LessonResponse
Properties:
| Name | Type | Description |
|---|---|---|
fileAssetId |
string
|
|
mp |
string
|
|
name |
string
|
|
sp |
string
|
|
wnid |
string
|
nodeId |
object
# LessonResponse
Response Object for GetLessonsBy*Quick endpoint
Properties:
| Name | Type | Description |
|---|---|---|
ActivityDisplayName |
string
|
Class Abereviation |
ActivityId |
string
|
|
ActivityImportIdentifier |
string
|
|
ActivityManagerId |
number
|
Manager ID |
AttendanceMode |
number
|
|
AttendeeCount |
number
|
|
AttendeeUserIdList |
Array.<number>
|
ID's of students in class |
CampusId |
number
|
|
CoveringIid |
string
|
|
CoveringPhotoPath |
string
|
|
CoveringUid |
number
|
|
CurrentInstance |
boolean
|
|
ExtendedStatusId |
number
|
|
FutureInstance |
boolean
|
|
IsClub |
boolean
|
|
IsExam |
boolean
|
|
IsMeeting |
boolean
|
|
IsSchoolApproval |
boolean
|
|
IsStandardClass |
boolean
|
Is a standard Class |
LocationId |
number
|
|
ManagerPhotoPath |
string
|
Teacher PFP |
ManagerTextReadable |
string
|
Teacher Name |
PastInstance |
boolean
|
|
ReadableAttendeeCount |
string
|
|
RunningStatus |
boolean
|
|
SubjectId |
string
|
|
SubjectName |
string
|
Class Title Full |
SubjectShortname |
string
|
|
UpcomingInstance |
boolean
|
|
fn |
string
|
Finish Time |
id |
string
|
Lesson ID |
l |
string
|
Lesson Room |
lp |
LessonPlan
|
|
m |
string
|
Teacher Name Abreviation |
managers |
Array.<Manager>
|
Teachers |
mi |
number
|
|
rollTapThreshold |
number
|
|
sessionCost |
number
|
|
st |
string
|
|
wsv |
string
|
object
# LessonSummaryResponse
Response Object for GetLessonsBy* endpoint
Properties:
| Name | Type | Description |
|---|---|---|
AcademicYearLevel |
string
|
|
ActivityDisplayName |
string
|
|
ActivityFinish |
string
|
|
ActivityId |
number
|
|
ActivityImportIdentifier |
string
|
|
ActivityManagerId |
string
|
|
ActivityStart |
string
|
|
Instances |
Array.<LessonResponse>
|
|
IsClub |
boolean
|
|
IsExam |
boolean
|
|
IsLearningTasksAdmin |
boolean
|
|
IsMeeting |
boolean
|
|
IsSchoolApproval |
boolean
|
|
IsStandardClass |
boolean
|
|
SubjectId |
number
|
|
SubjectName |
string
|
|
SubjectShortName |
string
|
object
# LessonsActivityIdRequest
Request Object for GetLessonsByActivityId* endpoint
Properties:
| Name | Type | Description |
|---|---|---|
activityId |
number
|
object
# LessonsInstanceIdRequest
Request Object for GetLessonsByInstanceId* endpoint
Properties:
| Name | Type | Description |
|---|---|---|
instanceId |
number
|
object
# Manager
Child Object of multiple Responses
Properties:
| Name | Type | Description |
|---|---|---|
CoveringImportIdentifier |
string
|
|
CoveringName |
string
|
|
CoveringPhotoPath |
string
|
|
CoveringUserId |
number
|
|
ManagerImportIdentifier |
string
|
|
ManagerName |
string
|
|
ManagerPhotoPath |
string
|
|
ManagerUserId |
number
|
object
# Result
Child Object of Student
Properties:
| Name | Type | Description |
|---|---|---|
flaggedResultType |
number
|
|
id |
number
|
|
isCalculatedResult |
boolean
|
|
isEstimatedResult |
boolean
|
|
lockedTimestamp |
string
|
|
modifiedByUserId |
number
|
|
modifiedTimestamp |
string
|
|
reportGradingSchemeOptionId |
string
|
|
result |
string
|
|
taskGradingItemId |
number
|
|
taskStudentId |
number
|
|
userIdLocked |
number
|
object
# Staff
Properties:
| Name | Type | Description |
|---|---|---|
baseRole |
number
|
|
campusId |
number
|
|
ce |
string
|
|
displayCode |
string
|
|
doNotContact |
boolean
|
|
f |
string
|
|
fn |
string
|
|
hasRegisteredDevice |
boolean
|
|
id |
number
|
|
ii |
string
|
|
ln |
string
|
|
mobileNumber |
string
|
|
n |
string
|
|
nameFirstPrefLastIdForm |
string
|
|
namePrefFirst |
string
|
|
namePrefLastId |
string
|
|
nif |
string
|
|
ns |
string
|
|
p |
string
|
|
parentIds |
Array.<number>
|
|
phoneExtension |
string
|
|
pv |
string
|
|
reportName |
string
|
|
rfid |
string
|
|
rfidCards |
Array.<any>
|
|
start |
string
|
|
sussiId |
string
|
object
# Student
Child Object of LearningTask
Properties:
| Name | Type | Description |
|---|---|---|
comments |
Array.<Comments>
|
|
dueDateTimestamp |
string
|
|
id |
number
|
|
lastSubmittedTimestamp |
string
|
|
primaryResult |
?
|
|
results |
Array.<Result>
|
|
selfAssessmentEnabled |
boolean
|
|
smsOutstandingSentTimestamp |
string
|
|
submissionStatus |
number
|
|
submissions |
Array.<Submission>
|
|
submittedTimestamp |
string
|
|
taskId |
number
|
|
teacherResponses |
?
|
|
userId |
number
|
|
userName |
string
|
object
# Submission
Child Object of Student
Properties:
| Name | Type | Description |
|---|---|---|
contentUrl |
string
|
|
fileId |
string
|
|
fileName |
string
|
|
id |
number
|
|
submissionFileType |
number
|
|
submitterBaseRole |
number
|
|
taskStudentId |
number
|
|
taskSubmissionItemId |
number
|
|
timestamp |
string
|
|
wikiNodeId |
number
|
object
# TaskItemBody
Child Object of *TaskItem* request and response
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id |
number
|
<optional> |
0 | |
status |
boolean
|
<optional> |
false | |
taskName |
string
|
|||
dueDate |
string
|
<optional> |
null |
object
# TaskItemRequest
Request Object of *TaskItem* endpoint
Properties:
| Name | Type | Description |
|---|---|---|
task |
TaskItemBody
|