Documentation

Application

Table of Contents

Classes

ClientFactory
GoogleSecretsToken
BlackbaudSKY
SkyAPIEndpoint
Client
Routing class for OneRoster
AcademicSessionModel
AcademicSessionOutputModel
AcademicSessionsOutputModel
CategoriesOutputModel
CategoryInputModel
CategoryModel
CategoryOutputModel
ClassesOutputModel
ClassModel
ClassOutputModel
CourseModel
CourseOutputModel
CoursesOutputModel
DemographicOutputModel
DemographicsOutputModel
EnrollmentModel
EnrollmentOutputModel
EnrollmentsOutputModel
GuidRefModel
LineItemInputModel
LineItemModel
LineItemOutputModel
LineItemsOutputModel
ORDemographicModel
OrgModel
OrgOutputModel
OrgsOutputModel
ORUserModel
ResultInputModelSvc
Results input model
ResultModelSvc
Results model
ResultOutputModelSvc
Result
ResultsOutputModelSvc
Result
StatusInfoModel
UserIdModel
UserOutputModel
UsersOutputModel
AcademicSessions
Categories
Categories
Results
LineItems
Routing class for the subnamespace `LineItems`
Results
Results
Students
Routing class for the subnamespace `Students`
Teachers
Classes
Routing class for the subnamespace `Classes`
Courses
Demographics
Enrollments
GradingPeriods
LineItems
Orgs
Results
Enrollments
Classes
Routing class for the subnamespace `Classes`
Courses
Enrollments
Students
Teachers
Terms
Schools
Routing class for the subnamespace `Schools`
Students
Classes
Teachers
Routing class for the subnamespace `Teachers`
GradingPeriods
Terms
Routing class for the subnamespace `Terms`
Users
Client
Routing class for School
AcademicsSection
Academics Section Model
AcademicsSectionCollection
A Collection
AcademicsSectionStudent
Student Academic Section Model
AcademicsSectionStudentCollection
A Collection
ActivitiesSection
Activities Section Model
ActivitiesSectionCollection
A Collection
AddressAdd
AddressAdd Model
AddressExRead
AddressExRead Model
AddressPatch
AddressPatch Model
AddressRead
AddressRead Model
AddressReadCollection
A Collection
AddressShare
AddressType
AddressType Model
AddressTypeCollection
A Collection
AddressTypeLink
AddressTypeLink Model
AddTableValuesRequest
Request object for adding table values
AddTableValuesResponse
Response object on adding table values
AdminCustomFields
AdminCustomFieldsCollection
A Collection
AdmissionsCheckList
Admissions Checklist
AdmissionsCheckListCollection
A Collection
AdmissionsChecklistStatus
Admissions Checklist Status
AdmissionsChecklistStatusCollection
A Collection
AdmissionsStatuses
Admissions Checklist
AdmissionsStatusesCollection
A Collection
Advisor
Advisor Model
AdvisoriesSection
Advisories Section Model
AdvisoriesSectionCollection
A Collection
AllergiesAndConditionsView
Student medical allergy/condition
AllergyRead
ApplicationModel
AreaOfStudyOutputModel
Assignment
Assignment Model
AssignmentCollection
A Collection
AssignmentType
Assignment Type Model
AthleticRequirementType
Athletic requirement type
AthleticRosters
An object with athletic roster user information
AthleticSectionRoster
An object with section roster information
AthleticVenue
AthleticVenueCollection
A Collection
AttendanceCreate
AttendanceGet
Attendance Model
AttendanceGetCollection
A Collection
AttendanceTypes
BuildingRead
BuildingReadCollection
A Collection
BuildingRoomRead
BulkEnrollment
Model to define bulk enrollments for both students and teachers
CalendarItem
Calendar item
CalendarItemCollection
A Collection
CandidateCreate
Candidate Create
CandidateDecisionModel
CandidateEventReadModel
An object with candidate event information
CandidateInterviewReadModel
An object with candidate interview information
CandidateRead
Candidate Read
CandidateReadCollection
A Collection
CandidateVisitReadModel
An object with candidate visit information
Category
News Category Model
ChildOfParent
UserRead Model
ChildOfParentCollection
A Collection
Coach
CoachCollection
A Collection
Concentration
ConditionRead
Course
CourseCollection
A Collection
CustomAdminField
Custom Field
CustumFieldReadModel
Custom Field Model for user or address or room or offering or section
Cycle
Days
Days for medication
Degree
DegreeOutputModel
Department
Department model
DepartmentCollection
A Collection
DirectoryModel
DirectoryModelCollection
A Collection
DirectoryResult
Directory Result Model
DirectoryResultCollection
A Collection
Dorm
DormCollection
A Collection
DormLeader
DormStudentInfo
Duration
An object describing the term or season for the section
EducationAdd
EducationAdd Model
EducationRead
EducationRead Model
EducationReadCollection
A Collection
EducationUpdate
EducationUpdate Model
EmergencyContactChange
Emergency Contact Changes
EmergencyContactChangeCollection
A Collection
EmergencyContactChangeEmail
Emergency Contact Change Email Model
EmergencyContactChangePhone
Emergency Contact Change Phone Model
EmergencyContactEmail
Emergency Contact Email Model
EmergencyContactList
Emergency Contact List Model
EmergencyContactNonUserCreate
Used to create a non-user emergency contact
EmergencyContactPhone
Emergency Contact Phone Model
EmergencyContactUserCreate
Used to create an emergency contact for a user.
EmployeeDepartmentsEditModel
EmployeeDepartmentsInfoModel
EmployeeRolesInfoModel
Employee Roles Info Model
Enrollment
Section Model
EnrollmentChangeAudit
EnrollmentChanges
Enrollment Changes Model
EnrollmentChangesCollection
A Collection
EnrollmentCollection
A Collection
EventCategory
Event Category Model
EventCategoryCollection
A Collection
EventCategoryCreateResponseExample
EventCategoryCreateResponseExample
EventsCategory
Events Category Model
EventsCategoryCollection
A Collection
ExcusedTypes
ExcusedTypesCollection
A Collection
ExcuseDurationTypes
FacultyEmploymentRead
FacultyEmploymentRead model
Field
List Field
GameCreate
GameOpponent
A game opponent
GameTime
GameTransportation
GameUpdate
GenderType
GenderTypeCollection
A Collection
GradeLevel
GradeLevel Model
GradeLevelCollection
A Collection
Highlight
Highlight model for athletic game highlights
HighlightPhoto
Photo model
HomeLanguageAdd
HomeLanguageAdd Model
HomeLanguageRead
IdDescriptorField
Leader
Leader Model
Level
An object with school level information
LevelCollection
A Collection
List_
List Model
ListRead
ListRead Class
ListReadCollection
A Collection
ListResult
List Collection
Location
LocationCollection
A Collection
LocationCreateModel
Major
MasterScheduleBlock
MasterScheduleDay
MasterScheduleDayCollection
A Collection
MasterScheduleSet
MediaItem
Media Model
MedicalSecurityRole
MedicationDosage
MedicationDosageCreate
Determines the frequency the medication is dispensed.
Meeting
Meeting
MeetingCollection
A Collection
Minor
NewsCategory
NewsCategory Model
NewsCategoryCollection
A Collection
NewsItem
NewsItem Model
NewsItemCollection
A Collection
OccupationCreate
OccupationRead
OccupationRead Model
OccupationReadCollection
A Collection
OccupationUpdate
OfferingAdminCustomFieldCreate
An object with custom field information
OfferingAdminCustomFieldUpdate
An object with custom field information
OfferingModel
An object with offering information
OfferingType
An object with offering type information
OfferingTypeCollection
A Collection
Opponent
OpponentFlyweight
OpponentFlyweightCollection
A Collection
OpponentUpdateModel
PhoneAdd
PhoneAdd Model
PhoneRead
PhoneRead Model
PhoneReadCollection
A Collection
PhoneShare
PhoneType
PhoneType Model
PhoneTypeCollection
A Collection
PhoneTypeLink
PhoneTypeLink Model
PhoneUpdate
PhoneUpdate Model
PhotoUrls
Player Photos Url (roster photo or profile photo)
Player
Player
PlayerCollection
A Collection
PostResponse
PracticeCreate
PracticeUpdate
ProfilePictureUrls
An object with profile photo and thumbnail
RaceRead
RaceRead Model
RelationshipCreate
RelationshipRead
RelationshipRead Model
RelationshipReadCollection
A Collection
RelationshipUpdate
Resident
Resource_
ResourceCollection
A Collection
ResultCreate
Result Create Model
ResultCreateOpponent
Role
Role Model
RoleCollection
A Collection
Room
Roster
RosterLeader
An object with leader information
RosterUser
An object with roster user information
Row
Row Model
Salutations
Salutations Model
ScheduleItem
ScheduleItemCollection
A Collection
ScheduleSet
ScheduleSetAccess
ScheduleSetCollection
A Collection
ScheduleSetDetails
ScheduleSetMettingPattern
ScheduleSetMettingTime
ScheduleSetRotation
ScheduleSetRotationDay
ScheduleSetRotationDayMeeting
SchoolBbidStatus
SchoolBbidStatusCollection
A Collection
SchoolDecisionModel
SchoolLevel
An object with school level information
SchoolSession
SchoolSessionCollection
A Collection
Season
Season Model
Section
An object with section information
SectionAdminCustomFieldCreate
SectionAdminCustomFieldUpdate
An object with custom field information
SectionCycles
SectionRosterModel
An object with section roster information
SecurityRole
Roles in the Education Management system that can see an allergy or condition
SecurityRoleCollection
A Collection
SourceModel
SpecialDay
SpecialDayBlock
SpecialDayCollection
A Collection
Sport
Sports Model
SportCollection
A Collection
SportsLevel
SportsLevelCollection
A Collection
Student
Student Model
StudentAccessRole
An object for access role information.
StudentAllergiesView
Student medical allergy
StudentAllergyUpdate
Student allergy update
StudentAssignment
StudentAssignmentCollection
A Collection
StudentAthleticRequirement
Athletic requirement
StudentAthleticRequirementRead
Student athletic clearance requirement model
StudentAthleticRequirementUpdate
Student medication
StudentCollection
A Collection
StudentConditionUpdate
Student condition update
StudentConditionView
Student medical condition
StudentGradedAssignment
Student Graded Assignments Model
StudentGradedAssignmentCollection
A Collection
StudentImmunization
Student immunization
StudentImmunizationRead
Student medication
StudentImmunizationType
Student immunization type
StudentImmunizationUpdate
Student medication
StudentInfo
StudentInfo Model
StudentMedicalAllergy
Student medical allergy
StudentMedicalAllergyCondition
Student medical allergy/condition
StudentMedicalCondition
Student medical condition
StudentMedication
An object for student medication information
StudentMedicationCreate
Student medication create
StudentMedicationRead
Student medication
StudentMedicationUpdate
Student medication
StudentSchedule
Schedule Item
StudentScheduleCollection
A Collection
SubTest
SubTest Model
Table
TableCollection
A Collection
TableValue
TableValueAdd
An object with table value information
TableValueCollection
A Collection
Teacher
Academic Teacher Model
Team
Team Model
TeamCollection
A Collection
Term
Term Model
TermCollection
A Collection
TestScore
TestScores Model
TestScoreAdd
TestScores Model
TestScoreCollection
A Collection
TestType
TestTypeCollection
A Collection
Timezone
Timezone model
Transportation
TransportationCollection
A Collection
UserAdd
UserAdd Model
UserAddRace
RaceAdd Model
UserAdminCustomField
UserAdminCustomField
UserAdminCustomFieldCollection
A Collection
UserAdminCustomFieldCreate
Object that describes the custom field to be created
UserAdminCustomFieldUpdate
Object that describes the custom field to be created
UserAreaOfStudyReferenceOutputModel
UserAuditRead
Contains the audit information for a single field
UserAuditReadCollection
A Collection
UserBaseRead
UserBaseRead Model
UserBaseReadModel
User base read model
UserDefinedTable
User Defined Table
UserDefinedTableValue
User Defined Table Values
UserDegreeOutputModel
UserDegreeOutputModelCollection
A Collection
UserEdit
UserEdit Model
UserEmployment
UserEmployment Model
UserEmploymentCollection
A Collection
UserEmploymentUpdate
UserEmploymentUpdate Model
UserEnrollment
User Enrollment
UserEnrollmentCollection
A Collection
UserEnrollmentCreate
UserEnrollmentResponse
UserExtended
UserExtended Model
UserExtendedCollection
A Collection
UserInState
An object for in-state resident information
UserLocker
An object for locker information
UserMailbox
An object for mailbox information
UserMajorMinorConcentrationOutputModel
UserMe
UserPassport
An object for passport information
UserProfilePhoto
profile photo object
UserRead
UserRead Model
UserReadCollection
A Collection
UserVisa
An object for visa information
UserVisaAdd
An object for visa information
Year
An object with school year information
YearCollection
A Collection
Assignments
List_
Customfields
Routing class for the subnamespace `Customfields`
Courses
Routing class for the subnamespace `Courses`
Departments
Changes
Enrollments
Routing class for the subnamespace `Enrollments`
Gradedassignments
Rosters
Master
Sets
Schedules
Routing class for the subnamespace `Schedules`
Assignments
List_
Customfields
Routing class for the subnamespace `Customfields`
Cycles
Students
Sections
Routing class for the subnamespace `Sections`
Specialdays
Sections
Student
Routing class for the subnamespace `Student`
Sections
Teachers
Routing class for the subnamespace `Teachers`
Academics
Routing class for the subnamespace `Academics`
Rosters
Sections
Activities
Routing class for the subnamespace `Activities`
Candidates
Checklists
Checkliststatus
Status
Admissions
Routing class for the subnamespace `Admissions`
Rosters
Sections
Advisories
Routing class for the subnamespace `Advisories`
Highlights
Locations
Opponents
Result
Rosters
Schedules
Sports
Sportslevels
Roster
Practice
Schedule
Routing class for the subnamespace `Schedule`
Teams
Routing class for the subnamespace `Teams`
Transportationtypes
Venues
Athletics
Routing class for the subnamespace `Athletics`
Attendance
Rosters
Communitygroups
Routing class for the subnamespace `Communitygroups`
Categories
Events
Routing class for the subnamespace `Events`
Categories
Items
News
Routing class for the subnamespace `News`
Resources
Content
Routing class for the subnamespace `Content`
Customfields
Studentdegrees
Degrees
Routing class for the subnamespace `Degrees`
Directories
All
Rosters
Dorms
Routing class for the subnamespace `Dorms`
Calendar
Categories
Events
Routing class for the subnamespace `Events`
Gradelevels
Levels
Advanced
Lists
Routing class for the subnamespace `Lists`
Allergies
Allergiesconditions
Athleticclearance
Conditions
Immunizations
Medications
Securityroles
Allergies
Allergiesconditions
Athleticrequirements
Conditions
Immunizations
Medications
Users
Routing class for the subnamespace `Users`
Medical
Routing class for the subnamespace `Medical`
Offeringtypes
Roles
Meetings
Schedules
Routing class for the subnamespace `Schedules`
Sessions
Terms
All
Testtypes
Testscores
Routing class for the subnamespace `Testscores`
Timezone
Attendancetypes
Excusedtypes
Excusedurationtypes
Tables
Tablevalues
Types
Routing class for the subnamespace `Types`
Share
Addresses
Routing class for the subnamespace `Addresses`
Addresstypes
Audit
Bbidstatus
Changed
List_
Customfields
Routing class for the subnamespace `Customfields`
Education
Changed
Nonuser
User
Emergencycontacts
Routing class for the subnamespace `Emergencycontacts`
Employment
Enroll
Enrollments
Extended
Gendertypes
Me
Occupations
Share
Phones
Routing class for the subnamespace `Phones`
Phonetypes
Relationships
Students
Users
Routing class for the subnamespace `Users`
Buildings
Venues
Routing class for the subnamespace `Venues`
Years
V1
Routing class for the subnamespace `V1`
GroupingGenerator
GroupingGenerator
ListEndpointFactory
We know that, consistently, GET endpoints that return components whose names end in "Collection" would be better named as "list" or "filter"
Runner

Constants

PUBLIC_PATH  = __DIR__ . '/../public'
WORKFLOW_PATH  = __DIR__ . '/Actions'

Constants

PUBLIC_PATH

public mixed PUBLIC_PATH = __DIR__ . '/../public'

WORKFLOW_PATH

public mixed WORKFLOW_PATH = __DIR__ . '/Actions'

        
On this page

Search results