Developer Documentation

inBloom Technology Application Developer Documentation

1.13.91


Introduction to Development for inBloom
What You Should Already Know
Using This Documentation
Conventions
Documentation Release Notes
Overview and First Steps for inBloom Application Development
Data Model Overview
Core Concepts for the inBloom Data Model
Data Types and Custom Data
Development Overview
Sandbox and Production Environments
Developer Collaboration in the Sandbox
inBloom Development Workflow
Sign Up and Log In
Sign up for a Developer Account
Log In to the Sandbox
Log In to Production
Add Data to the Sandbox
Add inBloom Sample Data
Add Custom Data to your Sandbox
Registering and Enabling Applications in the Sandbox
Register Your Application in the Sandbox
Enable Your Application in the Sandbox
Default Applications in the Sandbox
Portal
inBloom Dashboards
inBloom Data Browser
Managing the Sandbox and Testing Applications
Managing User Roles and Rights
Adding a New Role Group
Multiple Local IDP Roles Mapped to One inBloom Role
Managing Custom Roles for Multiple Realms
Creating Developer Accounts
Creating a New Developer
User Account Activation
Testing Your Application in the Sandbox
Using the inBloom REST API
inBloom REST API Overview
Core Concepts for the inBloom REST API
inBloom REST API Features
XML Schema Definition (XSD) for the REST API
Install a REST Client and Establish a Session
inBloom REST API Resources and URI Patterns
Resource Naming Conventions
Direct References and Associations
API Versioning
Pre-filtering Context Resolution
Basic URI Patterns
URI Patterns for Resources in Context
Resource Representations
Examples of XML Resource Representations
Using HATEOAS Links to Navigate the Data Model
Summary of URI Patterns
URI Query Segments
Search
Custom Endpoints
inBloom REST API Methods, Parameters, and Operators
HTTP Methods
HTTP Response Codes
HTTP Response Headers
Error Codes
Global Parameters
Query Operators
inBloom REST API Example Walk Through: Recording Grades for a Quiz
Using the inBloom SDKs
inBloom Java SDK Overview
Setting Up the Java SDK
Java SDK: Applications Managed with Maven
Java SDK: Applications Not Managed with Maven
Using the Java SDK in Application Development
Java SDK: Authentication
Java SDK: Sending REST API Requests with SLIClient
Java SDK: Sending REST API Requests with RESTClient
Sample Application: Java SDK "Hello World"
Source
Prerequisites
Configuration
Running using Jetty
Running using Tomcat
Using the Sample Application
inBloom JavaScript SDK
Setting up the JavaScript SDK
Using the JavaScript SDK Library
Using the JavaScript SDK Sample Application
Common Application Features
Adding User Authentication to Applications
User Authentication Process Overview
Signing In, Creating Sessions
Checking the Session
Using Authorization Tokens During a Session
Signing Out
Timing Out
Handling Response Codes, Including Errors
Providing Application Authorization Credentials to inBloom
Bypassing Realm Selection on Sign-in
How Application Registration Works
Registering Your Application in Production
Registering New Applications for inBloom
inBloom Application Development: Sample Applications and Code
Sample Code: Data Browser
Sample Data Browser: Installing
Sample Data Browser: Registering and Configuring
Sample Code: Dashboard
Sample Dashboard: Installing and Registering
Sample Dashboard: Configuring
Ingestion Client Batch Tool for Windows
Ingestion Validation Tool
System Requirements
Components and Build Instructions
Usage
inBloom Validation Tool Implementation
inBloom Data Store Logical Model
Introduction to the inBloom Data Store Logical Model
Data Domains
Alternative/Supplemental Services Domain
Assessment Domain
Career and Technical Education Domain
Discipline Domain
Education Organization Domain
Enrollment Domain
Graduation Domain
School Calendar Domain
Special Education Domain
Staff Domain
Student Academic Record Domain
Student Attendance Domain
Student Cohort Domain
Student Identification and Demographics Domain
Teaching and Learning Domain
Entities
AcademicHonor
AcademicSubjectsType
AcademicWeek
AccountabilityRating
AdditionalCredits
Address
Assessment
AssessmentFamily
AssessmentIdentificationCode
AssessmentItem
AssessmentPerformanceLevel
AssessmentPeriodDescriptor
Attendance
AttendanceEvent
BehaviorDescriptor
BehaviorDescriptorType
BellSchedule
BirthData
CTEProgram
CalendarDate
ClassPeriod
ClassRanking
Cohort
CohortYear
CompetencyLevelDescriptor
CompetencyLevelDescriptorType
Course
CourseCode
CourseOffering
CourseTranscript
Credential
CredentialFieldDescriptor
Credits
CreditsByCourse
CreditsBySubject
Diploma
Disability
DisciplineAction
DisciplineDescriptor
DisciplineDescriptorType
DisciplineIncident
EducationOrgIdentificationCode
EducationOrganization
EducationalOrgIdentityType
ElectronicMail
EmploymentPeriod
FeederSchoolType
Grade
GradebookEntry
GradingPeriod
GradingPeriodIdentityType
GraduationPlan
Home
HomeLanguageItemType
InstitutionTelephone
LanguageItemType
LearningObjective
LearningObjectiveIdentityType
LearningStandard
LearningStandardId
LearningStandardIdentityType
LearningStyles
Links
MeetingTime
MiscellaneousEvent
Name
ObjectiveAssessment
OtherName
Parent
PerformanceLevelDescriptor
PostSecondaryEvent
Program
ProgramParticipation
Recognition
ReportCard
RestraintEvent
RestraintEventReasonsType
School
SchoolYearAttendanceType
ScoreResult
SecondaryBehavior
Section
ServiceDescriptor
ServiceDescriptorType
Session
Staff
StaffCohortAssociation
StaffEducationOrganizationAssociation
StaffIdentificationCode
StaffProgramAssociation
Student
StudentAcademicRecord
StudentAssessment
StudentAssessmentItem
StudentCTEProgramAssociation
StudentCharacteristic
StudentCohortAssociation
StudentCompetency
StudentCompetencyObjective
StudentCompetencyObjectiveReference
StudentDisciplineIncidentAssociation
StudentGradebookEntry
StudentIdentificationCode
StudentIndicator
StudentObjectiveAssessment
StudentParentAssociation
StudentProgramAssociation
StudentSchoolAssociation
StudentSectionAssociation
StudentSpecialEdProgramAssociation
Subdoc_studentAssessmentItem
Subdoc_studentObjectiveAssessment
Teacher
TeacherSchoolAssociation
TeacherSectionAssociation
Telephone
WeaponsType
Enumerations
AcademicHonorsType
AcademicSubjectType
AdditionalCreditType
AddressType
AdministrationEnvironmentType
AdministrativeFundingControlType
AssessmentCategoryType
AssessmentIdentificationSystemType
AssessmentItemResultType
AssessmentReportingMethodType
AttendanceEventCategoryType
AttendanceEventType
BehaviorCategoryType
CalendarEventType
CareerPathwayType
CharterStatusType
ClassroomPositionType
CohortScopeType
CohortType
CohortYearType
ContentStandardType
CountryCodeType
CountryType
CourseAttemptResultType
CourseCodeSystemType
CourseDefinedByType
CourseGPAApplicabilityType
CourseLevelCharacteristicItemType
CourseLevelType
CourseRepeatCodeType
CredentialType
CreditType
DiplomaLevelType
DiplomaType
DisabilityType
DisciplineActionLengthDifferenceReasonType
EducationOrgIdentificationSystemType
EducationalEnvironmentType
EducationalPlanItemType
ElectronicMailAddressType
EmploymentStatusType
EntryType
EnvironmentType
ExitWithdrawType
GPAWeightedType
GenerationCodeSuffixType
GradeLevelType
GradeType
GradingPeriodType
GraduationPlanType
IdeaEligibilityType
IncidentLocationType
InstitutionTelephoneNumberType
ItemCategoryType
LEACategoryType
LeaveEventCategoryType
LevelOfEducationType
LevelType
LimitedEnglishProficiencyType
LinguisticAccommodationItemType
MagnetSpecialProgramEmphasisSchoolType
MediumOfInstructionType
MeetingDayItemType
MethodCreditEarnedType
OldEthnicityType
OperationalStatusType
OtherNameType
PerformanceBaseType
PersonalInformationVerificationType
PersonalTitlePrefixType
PopulationServedType
PostSecondaryEventCategoryType
PostingResultType
ProgramAssignmentType
ProgramSponsorType
ProgramType
RaceItemType
ReasonExitedType
ReasonNotTestedType
RecognitionType
RelationType
RepeatIdentifierType
ReporterDescriptionType
ResponseIndicatorType
RestraintEventReasonItemType
RetestIndicatorType
SchoolCategoryItemType
SchoolFoodServicesEligibilityType
SchoolType
SchoolYearType
Section504DisabilityItemType
SeparationReasonType
SeparationType
SexType
SpecialAccommodationItemType
StaffIdentificationSystemType
StateAbbreviationType
StudentCharacteristicType
StudentIdentificationSystemType
StudentParticipationCodeType
TeachingCredentialBasisType
TeachingCredentialType
TelephoneNumberType
TermType
TitleIPartAParticipantType
TitleIPartASchoolDesignationType
WeaponItemType
Data Types
inBloom REST API Resources
How to Use This Reference
What's the REST API documentation?
inBloom REST API System Resources
Authenticate Users Against a Tenant's IDP
saml/sso/post
saml/metadata
Manage User Sessions
system/session/check
system/session/logout
system/session/debug
Access User-specific Information
userapps
system/support/email
Manage inBloom Administrative Users
users
users/id
users/edorgs
Manage Custom User Roles for inBloom
customRoles
customRoles/{id}
Manage Tenants for inBloom
tenants
tenants/id
tenants-id-preload
provision
Manage Realms for inBloom
realm
realm/{id}
Authorize Applications for Tenants
applicationAuthorization
applicationAuthorization/{id}
Register Applications for Use by inBloom Users
apps
apps/{id}
Delegate Administration of an Education Organization
adminDelegation
adminDelegation/myEdOrg
Monitor Security Events
securityEvent
securityEvent/{id}
Extract Tenant Data in a Bulk Operation
Bulk Extract Files
Bulk Extract Header Fields
Authentication for Bulk Extract Operations
Encryption for Bulk Extract Operations
Bulk Extract Error Reporting
Top Level Education Organization Extract
bulk/extract
bulk/extract/list
bulk/extract/{EducationAgencyId}
bulk/extract/public
bulk/extract/{EducationAgencyId}/delta/{timestamp}
bulk/extract/public/delta/{timestamp}
API version 1.3: Data Resources
assessments
assessments/{id}
assessments/{id}/custom
assessments/{id}/learningObjectives
assessments/{id}/learningStandards
assessments/{id}/studentAssessments
attendances
attendances/{id}
attendances/{id}/custom
calendarDates
calendarDates/{id}
calendarDates/{id}/custom
cohorts
cohorts/{id}
cohorts/{id}/custom
cohorts/{id}/staffCohortAssociations
cohorts/{id}/staffCohortAssociations/staff
cohorts/{id}/studentCohortAssociations
cohorts/{id}/studentCohortAssociations/students
competencyLevelDescriptor
competencyLevelDescriptor/{id}
competencyLevelDescriptor/{id}/custom
courseOfferings
courseOfferings/{id}
courseOfferings/{id}/custom
courseOfferings/{id}/courses
courseOfferings/{id}/sections
courseOfferings/{id}/sessions
courseTranscripts
courseTranscripts/{id}
courseTranscripts/{id}/custom
courseTranscripts/{id}/courses
courseTranscripts/{id}/students
courses
courses/{id}
courses/{id}/custom
courses/{id}/courseOfferings
courses/{id}/courseOfferings/sessions
courses/{id}/courseTranscripts
disciplineActions
disciplineActions/{id}
disciplineActions/{id}/custom
disciplineIncidents
disciplineIncidents/{id}
disciplineIncidents/{id}/custom
disciplineIncidents/{id}/studentDisciplineIncidentAssociations
disciplineIncidents/{id}/studentDisciplineIncidentAssociations/students
educationOrganizations
educationOrganizations/{id}
educationOrganizations/{id}/custom
educationOrganizations/{id}/calendarDates
educationOrganizations/{id}/cohorts
educationOrganizations/{id}/courses
educationOrganizations/{id}/educationOrganizations
educationOrganizations/{id}/graduationPlans
educationOrganizations/{id}/schools
educationOrganizations/{id}/sessions
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations/staff
educationOrganizations/{id}/studentCompetencyObjectives
educationOrganizations/{id}/studentSchoolAssociations
educationOrganizations/{id}/studentSchoolAssociations/students
educationOrganizations/{id}/teacherSchoolAssociations
educationOrganizations/{id}/teacherSchoolAssociations/teachers
gradebookEntries
gradebookEntries/{id}
gradebookEntries/{id}/custom
gradebookEntries/{id}/studentGradebookEntries
grades
grades/{id}
grades/{id}/custom
gradingPeriods
gradingPeriods/{id}
gradingPeriods/{id}/custom
gradingPeriods/{id}/calendarDates
gradingPeriods/{id}/grades
gradingPeriods/{id}/reportCards
graduationPlans
graduationPlans/{id}
graduationPlans/{id}/custom
home
learningObjectives
learningObjectives/{id}
learningObjectives/{id}/custom
learningObjectives/{id}/childLearningObjectives
learningObjectives/{id}/learningStandards
learningObjectives/{id}/parentLearningObjectives
learningObjectives/{id}/studentCompetencies
learningStandards
learningStandards/{id}
learningStandards/{id}/custom
parents
parents/{id}
parents/{id}/custom
parents/{id}/studentParentAssociations
parents/{id}/studentParentAssociations/students
programs
programs/{id}
programs/{id}/custom
programs/{id}/staffProgramAssociations
programs/{id}/staffProgramAssociations/staff
programs/{id}/studentProgramAssociations
programs/{id}/studentProgramAssociations/students
reportCards
reportCards/{id}
reportCards/{id}/custom
schools
schools/{id}
schools/{id}/custom
schools/{id}/courseOfferings
schools/{id}/courses
schools/{id}/graduationPlans
schools/{id}/sections
schools/{id}/sections/gradebookEntries
schools/{id}/sections/studentSectionAssociations
schools/{id}/sections/studentSectionAssociations/grades
schools/{id}/sections/studentSectionAssociations/studentCompetencies
schools/{id}/sessions
schools/{id}/sessions/gradingPeriods
schools/{id}/staffEducationOrgAssignmentAssociations
schools/{id}/staffEducationOrgAssignmentAssociations/staff
schools/{id}/studentSchoolAssociations
schools/{id}/studentSchoolAssociations/students
schools/{id}/studentSchoolAssociations/students/attendances
schools/{id}/studentSchoolAssociations/students/courseTranscripts
schools/{id}/studentSchoolAssociations/students/reportCards
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords/courseTranscripts
schools/{id}/studentSchoolAssociations/students/studentAssessments
schools/{id}/studentSchoolAssociations/students/studentGradebookEntries
schools/{id}/studentSchoolAssociations/students/studentParentAssociations
schools/{id}/studentSchoolAssociations/students/studentParentAssociations/parents
schools/{id}/teacherSchoolAssociations
schools/{id}/teacherSchoolAssociations/teachers
schools/{id}/teacherSchoolAssociations/teachers/teacherSectionAssociations
sections
sections/{id}
sections/{id}/custom
sections/{id}/gradebookEntries
sections/{id}/studentGradebookEntries
sections/{id}/studentSectionAssociations
sections/{id}/studentSectionAssociations/grades
sections/{id}/studentSectionAssociations/studentCompetencies
sections/{id}/studentSectionAssociations/students
sections/{id}/studentSectionAssociations/students/attendances
sections/{id}/studentSectionAssociations/students/courseTranscripts
sections/{id}/studentSectionAssociations/students/reportCards
sections/{id}/studentSectionAssociations/students/studentAcademicRecords
sections/{id}/studentSectionAssociations/students/studentAcademicRecords/courseTranscripts
sections/{id}/studentSectionAssociations/students/studentAssessments
sections/{id}/studentSectionAssociations/students/studentGradebookEntries
sections/{id}/studentSectionAssociations/students/studentParentAssociations
sections/{id}/studentSectionAssociations/students/studentParentAssociations/parents
sections/{id}/studentSectionAssociations/students/studentSchoolAssociations
sections/{id}/studentSectionAssociations/students/yearlyAttendances
sections/{id}/teacherSectionAssociations
sections/{id}/teacherSectionAssociations/teachers
sessions
sessions/{id}
sessions/{id}/custom
sessions/{id}/courseOfferings
sessions/{id}/courseOfferings/courses
sessions/{id}/sections
sessions/{id}/studentAcademicRecords
staff
staff/{id}
staff/{id}/custom
staff/{id}/disciplineActions
staff/{id}/disciplineIncidents
staff/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
staff/{id}/staffCohortAssociations
staff/{id}/staffCohortAssociations/cohorts
staff/{id}/staffCohortAssociations/cohorts/studentCohortAssociations
staff/{id}/staffEducationOrgAssignmentAssociations
staff/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
staff/{id}/staffEducationOrgAssignmentAssociations/schools
staff/{id}/staffProgramAssociations
staff/{id}/staffProgramAssociations/programs
staff/{id}/staffProgramAssociations/programs/studentProgramAssociations
staff/{id}/teacherSchoolAssociations
staff/{id}/teacherSchoolAssociations/schools
staff/{id}/teacherSectionAssociations
staff/{id}/teacherSectionAssociations/sections
staffCohortAssociations
staffCohortAssociations/{id}
staffCohortAssociations/{id}/custom
staffCohortAssociations/{id}/cohorts
staffCohortAssociations/{id}/staff
staffEducationOrgAssignmentAssociations
staffEducationOrgAssignmentAssociations/{id}
staffEducationOrgAssignmentAssociations/{id}/custom
staffEducationOrgAssignmentAssociations/{id}/educationOrganizations
staffEducationOrgAssignmentAssociations/{id}/staff
staffProgramAssociations
staffProgramAssociations/{id}
staffProgramAssociations/{id}/custom
staffProgramAssociations/{id}/programs
staffProgramAssociations/{id}/staff
studentAcademicRecords
studentAcademicRecords/{id}
studentAcademicRecords/{id}/custom
studentAcademicRecords/{id}/courseTranscripts
studentAssessments
studentAssessments/{id}
studentAssessments/{id}/custom
studentAssessments/{id}/assessments
studentAssessments/{id}/students
studentCohortAssociations
studentCohortAssociations/{id}
studentCohortAssociations/{id}/custom
studentCohortAssociations/{id}/cohorts
studentCohortAssociations/{id}/students
studentCompetencies
studentCompetencies/{id}
studentCompetencies/{id}/custom
studentCompetencies/{id}/reportCards
studentCompetencyObjectives
studentCompetencyObjectives/{id}
studentCompetencyObjectives/{id}/custom
studentDisciplineIncidentAssociations
studentDisciplineIncidentAssociations/{id}
studentDisciplineIncidentAssociations/{id}/custom
studentDisciplineIncidentAssociations/{id}/disciplineIncidents
studentDisciplineIncidentAssociations/{id}/students
studentGradebookEntries
studentGradebookEntries/{id}
studentGradebookEntries/{id}/custom
studentParentAssociations
studentParentAssociations/{id}
studentParentAssociations/{id}/custom
studentParentAssociations/{id}/parents
studentParentAssociations/{id}/students
studentProgramAssociations
studentProgramAssociations/{id}
studentProgramAssociations/{id}/custom
studentProgramAssociations/{id}/programs
studentProgramAssociations/{id}/students
studentSchoolAssociations
studentSchoolAssociations/{id}
studentSchoolAssociations/{id}/custom
studentSchoolAssociations/{id}/schools
studentSchoolAssociations/{id}/students
studentSectionAssociations
studentSectionAssociations/{id}
studentSectionAssociations/{id}/custom
studentSectionAssociations/{id}/grades
studentSectionAssociations/{id}/sections
studentSectionAssociations/{id}/studentCompetencies
studentSectionAssociations/{id}/students
students
students/{id}
students/{id}/custom
students/{id}/attendances
students/{id}/courseTranscripts
students/{id}/courseTranscripts/courses
students/{id}/reportCards
students/{id}/studentAcademicRecords
students/{id}/studentAcademicRecords/courseTranscripts
students/{id}/studentAcademicRecords/courseTranscripts/courses
students/{id}/studentAssessments
students/{id}/studentAssessments/assessments
students/{id}/studentCohortAssociations
students/{id}/studentCohortAssociations/cohorts
students/{id}/studentDisciplineIncidentAssociations
students/{id}/studentDisciplineIncidentAssociations/disciplineIncidents
students/{id}/studentGradebookEntries
students/{id}/studentParentAssociations
students/{id}/studentParentAssociations/parents
students/{id}/studentProgramAssociations
students/{id}/studentProgramAssociations/programs
students/{id}/studentSchoolAssociations
students/{id}/studentSchoolAssociations/schools
students/{id}/studentSectionAssociations
students/{id}/studentSectionAssociations/sections
students/{id}/yearlyAttendances
teacherSchoolAssociations
teacherSchoolAssociations/{id}
teacherSchoolAssociations/{id}/custom
teacherSchoolAssociations/{id}/schools
teacherSchoolAssociations/{id}/teachers
teacherSectionAssociations
teacherSectionAssociations/{id}
teacherSectionAssociations/{id}/custom
teacherSectionAssociations/{id}/sections
teacherSectionAssociations/{id}/teachers
teachers
teachers/{id}
teachers/{id}/custom
teachers/{id}/disciplineActions
teachers/{id}/disciplineIncidents
teachers/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
teachers/{id}/staffCohortAssociations
teachers/{id}/staffCohortAssociations/cohorts
teachers/{id}/staffEducationOrgAssignmentAssociations
teachers/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
teachers/{id}/staffProgramAssociations
teachers/{id}/staffProgramAssociations/programs
teachers/{id}/teacherSchoolAssociations
teachers/{id}/teacherSchoolAssociations/schools
teachers/{id}/teacherSectionAssociations
teachers/{id}/teacherSectionAssociations/sections
yearlyAttendances
yearlyAttendances/{id}
yearlyAttendances/{id}/custom
Example Requests & Responses for inBloom REST API v1.3
API version 1.2: Data Resources
assessments
assessments/{id}
assessments/{id}/custom
assessments/{id}/learningObjectives
assessments/{id}/learningStandards
assessments/{id}/studentAssessments
attendances
attendances/{id}
attendances/{id}/custom
cohorts
cohorts/{id}
cohorts/{id}/custom
cohorts/{id}/staffCohortAssociations
cohorts/{id}/staffCohortAssociations/staff
cohorts/{id}/studentCohortAssociations
cohorts/{id}/studentCohortAssociations/students
competencyLevelDescriptor
competencyLevelDescriptor/{id}
competencyLevelDescriptor/{id}/custom
courseOfferings
courseOfferings/{id}
courseOfferings/{id}/custom
courseOfferings/{id}/courses
courseOfferings/{id}/sections
courseOfferings/{id}/sessions
courseTranscripts
courseTranscripts/{id}
courseTranscripts/{id}/custom
courseTranscripts/{id}/courses
courseTranscripts/{id}/students
courses
courses/{id}
courses/{id}/custom
courses/{id}/courseOfferings
courses/{id}/courseOfferings/sessions
courses/{id}/courseTranscripts
disciplineActions
disciplineActions/{id}
disciplineActions/{id}/custom
disciplineIncidents
disciplineIncidents/{id}
disciplineIncidents/{id}/custom
disciplineIncidents/{id}/studentDisciplineIncidentAssociations
disciplineIncidents/{id}/studentDisciplineIncidentAssociations/students
educationOrganizations
educationOrganizations/{id}
educationOrganizations/{id}/custom
educationOrganizations/{id}/calendarDates
educationOrganizations/{id}/cohorts
educationOrganizations/{id}/courses
educationOrganizations/{id}/educationOrganizations
educationOrganizations/{id}/graduationPlans
educationOrganizations/{id}/schools
educationOrganizations/{id}/sessions
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations/staff
educationOrganizations/{id}/studentCompetencyObjectives
educationOrganizations/{id}/studentSchoolAssociations
educationOrganizations/{id}/studentSchoolAssociations/students
educationOrganizations/{id}/teacherSchoolAssociations
educationOrganizations/{id}/teacherSchoolAssociations/teachers
gradebookEntries
gradebookEntries/{id}
gradebookEntries/{id}/custom
gradebookEntries/{id}/studentGradebookEntries
grades
grades/{id}
grades/{id}/custom
gradingPeriods
gradingPeriods/{id}
gradingPeriods/{id}/custom
gradingPeriods/{id}/calendarDates
gradingPeriods/{id}/grades
gradingPeriods/{id}/reportCards
graduationPlans
graduationPlans/{id}
graduationPlans/{id}/custom
home
learningObjectives
learningObjectives/{id}
learningObjectives/{id}/custom
learningObjectives/{id}/childLearningObjectives
learningObjectives/{id}/learningStandards
learningObjectives/{id}/parentLearningObjectives
learningObjectives/{id}/studentCompetencies
learningStandards
learningStandards/{id}
learningStandards/{id}/custom
parents
parents/{id}
parents/{id}/custom
parents/{id}/studentParentAssociations
parents/{id}/studentParentAssociations/students
programs
programs/{id}
programs/{id}/custom
programs/{id}/staffProgramAssociations
programs/{id}/staffProgramAssociations/staff
programs/{id}/studentProgramAssociations
programs/{id}/studentProgramAssociations/students
reportCards
reportCards/{id}
reportCards/{id}/custom
schools
schools/{id}
schools/{id}/custom
schools/{id}/courseOfferings
schools/{id}/courses
schools/{id}/graduationPlans
schools/{id}/sections
schools/{id}/sections/gradebookEntries
schools/{id}/sections/studentSectionAssociations
schools/{id}/sections/studentSectionAssociations/grades
schools/{id}/sections/studentSectionAssociations/studentCompetencies
schools/{id}/sessions
schools/{id}/sessions/gradingPeriods
schools/{id}/staffEducationOrgAssignmentAssociations
schools/{id}/staffEducationOrgAssignmentAssociations/staff
schools/{id}/studentSchoolAssociations
schools/{id}/studentSchoolAssociations/students
schools/{id}/studentSchoolAssociations/students/attendances
schools/{id}/studentSchoolAssociations/students/courseTranscripts
schools/{id}/studentSchoolAssociations/students/reportCards
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords/courseTranscripts
schools/{id}/studentSchoolAssociations/students/studentAssessments
schools/{id}/studentSchoolAssociations/students/studentGradebookEntries
schools/{id}/studentSchoolAssociations/students/studentParentAssociations
schools/{id}/studentSchoolAssociations/students/studentParentAssociations/parents
schools/{id}/teacherSchoolAssociations
schools/{id}/teacherSchoolAssociations/teachers
schools/{id}/teacherSchoolAssociations/teachers/teacherSectionAssociations
sections
sections/{id}
sections/{id}/custom
sections/{id}/gradebookEntries
sections/{id}/studentGradebookEntries
sections/{id}/studentSectionAssociations
sections/{id}/studentSectionAssociations/grades
sections/{id}/studentSectionAssociations/studentCompetencies
sections/{id}/studentSectionAssociations/students
sections/{id}/studentSectionAssociations/students/attendances
sections/{id}/studentSectionAssociations/students/courseTranscripts
sections/{id}/studentSectionAssociations/students/reportCards
sections/{id}/studentSectionAssociations/students/studentAcademicRecords
sections/{id}/studentSectionAssociations/students/studentAcademicRecords/courseTranscripts
sections/{id}/studentSectionAssociations/students/studentAssessments
sections/{id}/studentSectionAssociations/students/studentGradebookEntries
sections/{id}/studentSectionAssociations/students/studentParentAssociations
sections/{id}/studentSectionAssociations/students/studentParentAssociations/parents
sections/{id}/studentSectionAssociations/students/studentSchoolAssociations
sections/{id}/studentSectionAssociations/students/yearlyAttendances
sections/{id}/teacherSectionAssociations
sections/{id}/teacherSectionAssociations/teachers
sessions
sessions/{id}
sessions/{id}/custom
sessions/{id}/courseOfferings
sessions/{id}/courseOfferings/courses
sessions/{id}/sections
sessions/{id}/studentAcademicRecords
staff
staff/{id}
staff/{id}/custom
staff/{id}/disciplineActions
staff/{id}/disciplineIncidents
staff/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
staff/{id}/staffCohortAssociations
staff/{id}/staffCohortAssociations/cohorts
staff/{id}/staffCohortAssociations/cohorts/studentCohortAssociations
staff/{id}/staffEducationOrgAssignmentAssociations
staff/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
staff/{id}/staffEducationOrgAssignmentAssociations/schools
staff/{id}/staffProgramAssociations
staff/{id}/staffProgramAssociations/programs
staff/{id}/staffProgramAssociations/programs/studentProgramAssociations
staff/{id}/teacherSchoolAssociations
staff/{id}/teacherSchoolAssociations/schools
staff/{id}/teacherSectionAssociations
staff/{id}/teacherSectionAssociations/sections
staffCohortAssociations
staffCohortAssociations/{id}
staffCohortAssociations/{id}/custom
staffCohortAssociations/{id}/cohorts
staffCohortAssociations/{id}/staff
staffEducationOrgAssignmentAssociations
staffEducationOrgAssignmentAssociations/{id}
staffEducationOrgAssignmentAssociations/{id}/custom
staffEducationOrgAssignmentAssociations/{id}/educationOrganizations
staffEducationOrgAssignmentAssociations/{id}/staff
staffProgramAssociations
staffProgramAssociations/{id}
staffProgramAssociations/{id}/custom
staffProgramAssociations/{id}/programs
staffProgramAssociations/{id}/staff
studentAcademicRecords
studentAcademicRecords/{id}
studentAcademicRecords/{id}/custom
studentAcademicRecords/{id}/courseTranscripts
studentAssessments
studentAssessments/{id}
studentAssessments/{id}/custom
studentAssessments/{id}/assessments
studentAssessments/{id}/students
studentCohortAssociations
studentCohortAssociations/{id}
studentCohortAssociations/{id}/custom
studentCohortAssociations/{id}/cohorts
studentCohortAssociations/{id}/students
studentCompetencies
studentCompetencies/{id}
studentCompetencies/{id}/custom
studentCompetencies/{id}/reportCards
studentCompetencyObjectives
studentCompetencyObjectives/{id}
studentCompetencyObjectives/{id}/custom
studentDisciplineIncidentAssociations
studentDisciplineIncidentAssociations/{id}
studentDisciplineIncidentAssociations/{id}/custom
studentDisciplineIncidentAssociations/{id}/disciplineIncidents
studentDisciplineIncidentAssociations/{id}/students
studentGradebookEntries
studentGradebookEntries/{id}
studentGradebookEntries/{id}/custom
studentParentAssociations
studentParentAssociations/{id}
studentParentAssociations/{id}/custom
studentParentAssociations/{id}/parents
studentParentAssociations/{id}/students
studentProgramAssociations
studentProgramAssociations/{id}
studentProgramAssociations/{id}/custom
studentProgramAssociations/{id}/programs
studentProgramAssociations/{id}/students
studentSchoolAssociations
studentSchoolAssociations/{id}
studentSchoolAssociations/{id}/custom
studentSchoolAssociations/{id}/schools
studentSchoolAssociations/{id}/students
studentSectionAssociations
studentSectionAssociations/{id}
studentSectionAssociations/{id}/custom
studentSectionAssociations/{id}/grades
studentSectionAssociations/{id}/sections
studentSectionAssociations/{id}/studentCompetencies
studentSectionAssociations/{id}/students
students
students/{id}
students/{id}/custom
students/{id}/attendances
students/{id}/courseTranscripts
students/{id}/courseTranscripts/courses
students/{id}/reportCards
students/{id}/studentAcademicRecords
students/{id}/studentAcademicRecords/courseTranscripts
students/{id}/studentAcademicRecords/courseTranscripts/courses
students/{id}/studentAssessments
students/{id}/studentAssessments/assessments
students/{id}/studentCohortAssociations
students/{id}/studentCohortAssociations/cohorts
students/{id}/studentDisciplineIncidentAssociations
students/{id}/studentDisciplineIncidentAssociations/disciplineIncidents
students/{id}/studentGradebookEntries
students/{id}/studentParentAssociations
students/{id}/studentParentAssociations/parents
students/{id}/studentProgramAssociations
students/{id}/studentProgramAssociations/programs
students/{id}/studentSchoolAssociations
students/{id}/studentSchoolAssociations/schools
students/{id}/studentSectionAssociations
students/{id}/studentSectionAssociations/sections
students/{id}/yearlyAttendances
teacherSchoolAssociations
teacherSchoolAssociations/{id}
teacherSchoolAssociations/{id}/custom
teacherSchoolAssociations/{id}/schools
teacherSchoolAssociations/{id}/teachers
teacherSectionAssociations
teacherSectionAssociations/{id}
teacherSectionAssociations/{id}/custom
teacherSectionAssociations/{id}/sections
teacherSectionAssociations/{id}/teachers
teachers
teachers/{id}
teachers/{id}/custom
teachers/{id}/disciplineActions
teachers/{id}/disciplineIncidents
teachers/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
teachers/{id}/staffCohortAssociations
teachers/{id}/staffCohortAssociations/cohorts
teachers/{id}/staffEducationOrgAssignmentAssociations
teachers/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
teachers/{id}/staffProgramAssociations
teachers/{id}/staffProgramAssociations/programs
teachers/{id}/teacherSchoolAssociations
teachers/{id}/teacherSchoolAssociations/schools
teachers/{id}/teacherSectionAssociations
teachers/{id}/teacherSectionAssociations/sections
yearlyAttendances
yearlyAttendances/{id}
yearlyAttendances/{id}/custom
Example Requests & Responses for inBloom REST API v1.2
API version 1.1: Data Resources
assessments
assessments/{id}
assessments/{id}/custom
assessments/{id}/learningObjectives
assessments/{id}/learningStandards
assessments/{id}/studentAssessments
attendances
attendances/{id}
attendances/{id}/custom
cohorts
cohorts/{id}
cohorts/{id}/custom
cohorts/{id}/staffCohortAssociations
cohorts/{id}/staffCohortAssociations/staff
cohorts/{id}/studentCohortAssociations
cohorts/{id}/studentCohortAssociations/students
competencyLevelDescriptor
competencyLevelDescriptor/{id}
competencyLevelDescriptor/{id}/custom
courseOfferings
courseOfferings/{id}
courseOfferings/{id}/custom
courseOfferings/{id}/courses
courseOfferings/{id}/sections
courseOfferings/{id}/sessions
courseTranscripts
courseTranscripts/{id}
courseTranscripts/{id}/custom
courseTranscripts/{id}/courses
courseTranscripts/{id}/students
courses
courses/{id}
courses/{id}/custom
courses/{id}/courseOfferings
courses/{id}/courseOfferings/sessions
courses/{id}/courseTranscripts
disciplineActions
disciplineActions/{id}
disciplineActions/{id}/custom
disciplineIncidents
disciplineIncidents/{id}
disciplineIncidents/{id}/custom
disciplineIncidents/{id}/studentDisciplineIncidentAssociations
disciplineIncidents/{id}/studentDisciplineIncidentAssociations/students
educationOrganizations
educationOrganizations/{id}
educationOrganizations/{id}/custom
educationOrganizations/{id}/calendarDates
educationOrganizations/{id}/cohorts
educationOrganizations/{id}/courses
educationOrganizations/{id}/educationOrganizations
educationOrganizations/{id}/graduationPlans
educationOrganizations/{id}/schools
educationOrganizations/{id}/sessions
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations/staff
educationOrganizations/{id}/studentCompetencyObjectives
educationOrganizations/{id}/studentSchoolAssociations
educationOrganizations/{id}/studentSchoolAssociations/students
educationOrganizations/{id}/teacherSchoolAssociations
educationOrganizations/{id}/teacherSchoolAssociations/teachers
gradebookEntries
gradebookEntries/{id}
gradebookEntries/{id}/custom
gradebookEntries/{id}/studentGradebookEntries
grades
grades/{id}
grades/{id}/custom
gradingPeriods
gradingPeriods/{id}
gradingPeriods/{id}/custom
gradingPeriods/{id}/calendarDates
gradingPeriods/{id}/grades
gradingPeriods/{id}/reportCards
graduationPlans
graduationPlans/{id}
graduationPlans/{id}/custom
home
learningObjectives
learningObjectives/{id}
learningObjectives/{id}/custom
learningObjectives/{id}/childLearningObjectives
learningObjectives/{id}/learningStandards
learningObjectives/{id}/parentLearningObjectives
learningObjectives/{id}/studentCompetencies
learningStandards
learningStandards/{id}
learningStandards/{id}/custom
parents
parents/{id}
parents/{id}/custom
parents/{id}/studentParentAssociations
parents/{id}/studentParentAssociations/students
programs
programs/{id}
programs/{id}/custom
programs/{id}/staffProgramAssociations
programs/{id}/staffProgramAssociations/staff
programs/{id}/studentProgramAssociations
programs/{id}/studentProgramAssociations/students
reportCards
reportCards/{id}
reportCards/{id}/custom
schools
schools/{id}
schools/{id}/custom
schools/{id}/courseOfferings
schools/{id}/courses
schools/{id}/graduationPlans
schools/{id}/sections
schools/{id}/sections/gradebookEntries
schools/{id}/sections/studentSectionAssociations
schools/{id}/sections/studentSectionAssociations/grades
schools/{id}/sections/studentSectionAssociations/studentCompetencies
schools/{id}/sessions
schools/{id}/sessions/gradingPeriods
schools/{id}/staffEducationOrgAssignmentAssociations
schools/{id}/staffEducationOrgAssignmentAssociations/staff
schools/{id}/studentSchoolAssociations
schools/{id}/studentSchoolAssociations/students
schools/{id}/studentSchoolAssociations/students/attendances
schools/{id}/studentSchoolAssociations/students/courseTranscripts
schools/{id}/studentSchoolAssociations/students/reportCards
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords/courseTranscripts
schools/{id}/studentSchoolAssociations/students/studentAssessments
schools/{id}/studentSchoolAssociations/students/studentGradebookEntries
schools/{id}/studentSchoolAssociations/students/studentParentAssociations
schools/{id}/studentSchoolAssociations/students/studentParentAssociations/parents
schools/{id}/teacherSchoolAssociations
schools/{id}/teacherSchoolAssociations/teachers
schools/{id}/teacherSchoolAssociations/teachers/teacherSectionAssociations
sections
sections/{id}
sections/{id}/custom
sections/{id}/gradebookEntries
sections/{id}/studentGradebookEntries
sections/{id}/studentSectionAssociations
sections/{id}/studentSectionAssociations/grades
sections/{id}/studentSectionAssociations/studentCompetencies
sections/{id}/studentSectionAssociations/students
sections/{id}/studentSectionAssociations/students/attendances
sections/{id}/studentSectionAssociations/students/courseTranscripts
sections/{id}/studentSectionAssociations/students/reportCards
sections/{id}/studentSectionAssociations/students/studentAcademicRecords
sections/{id}/studentSectionAssociations/students/studentAcademicRecords/courseTranscripts
sections/{id}/studentSectionAssociations/students/studentAssessments
sections/{id}/studentSectionAssociations/students/studentGradebookEntries
sections/{id}/studentSectionAssociations/students/studentParentAssociations
sections/{id}/studentSectionAssociations/students/studentParentAssociations/parents
sections/{id}/studentSectionAssociations/students/studentSchoolAssociations
sections/{id}/studentSectionAssociations/students/yearlyAttendances
sections/{id}/teacherSectionAssociations
sections/{id}/teacherSectionAssociations/teachers
sessions
sessions/{id}
sessions/{id}/custom
sessions/{id}/courseOfferings
sessions/{id}/courseOfferings/courses
sessions/{id}/sections
sessions/{id}/studentAcademicRecords
staff
staff/{id}
staff/{id}/custom
staff/{id}/disciplineActions
staff/{id}/disciplineIncidents
staff/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
staff/{id}/staffCohortAssociations
staff/{id}/staffCohortAssociations/cohorts
staff/{id}/staffCohortAssociations/cohorts/studentCohortAssociations
staff/{id}/staffEducationOrgAssignmentAssociations
staff/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
staff/{id}/staffEducationOrgAssignmentAssociations/schools
staff/{id}/staffProgramAssociations
staff/{id}/staffProgramAssociations/programs
staff/{id}/staffProgramAssociations/programs/studentProgramAssociations
staff/{id}/teacherSchoolAssociations
staff/{id}/teacherSchoolAssociations/schools
staff/{id}/teacherSectionAssociations
staff/{id}/teacherSectionAssociations/sections
staffCohortAssociations
staffCohortAssociations/{id}
staffCohortAssociations/{id}/custom
staffCohortAssociations/{id}/cohorts
staffCohortAssociations/{id}/staff
staffEducationOrgAssignmentAssociations
staffEducationOrgAssignmentAssociations/{id}
staffEducationOrgAssignmentAssociations/{id}/custom
staffEducationOrgAssignmentAssociations/{id}/educationOrganizations
staffEducationOrgAssignmentAssociations/{id}/staff
staffProgramAssociations
staffProgramAssociations/{id}
staffProgramAssociations/{id}/custom
staffProgramAssociations/{id}/programs
staffProgramAssociations/{id}/staff
studentAcademicRecords
studentAcademicRecords/{id}
studentAcademicRecords/{id}/custom
studentAcademicRecords/{id}/courseTranscripts
studentAssessments
studentAssessments/{id}
studentAssessments/{id}/custom
studentAssessments/{id}/assessments
studentAssessments/{id}/students
studentCohortAssociations
studentCohortAssociations/{id}
studentCohortAssociations/{id}/custom
studentCohortAssociations/{id}/cohorts
studentCohortAssociations/{id}/students
studentCompetencies
studentCompetencies/{id}
studentCompetencies/{id}/custom
studentCompetencies/{id}/reportCards
studentCompetencyObjectives
studentCompetencyObjectives/{id}
studentCompetencyObjectives/{id}/custom
studentDisciplineIncidentAssociations
studentDisciplineIncidentAssociations/{id}
studentDisciplineIncidentAssociations/{id}/custom
studentDisciplineIncidentAssociations/{id}/disciplineIncidents
studentDisciplineIncidentAssociations/{id}/students
studentGradebookEntries
studentGradebookEntries/{id}
studentGradebookEntries/{id}/custom
studentParentAssociations
studentParentAssociations/{id}
studentParentAssociations/{id}/custom
studentParentAssociations/{id}/parents
studentParentAssociations/{id}/students
studentProgramAssociations
studentProgramAssociations/{id}
studentProgramAssociations/{id}/custom
studentProgramAssociations/{id}/programs
studentProgramAssociations/{id}/students
studentSchoolAssociations
studentSchoolAssociations/{id}
studentSchoolAssociations/{id}/custom
studentSchoolAssociations/{id}/schools
studentSchoolAssociations/{id}/students
studentSectionAssociations
studentSectionAssociations/{id}
studentSectionAssociations/{id}/custom
studentSectionAssociations/{id}/grades
studentSectionAssociations/{id}/sections
studentSectionAssociations/{id}/studentCompetencies
studentSectionAssociations/{id}/students
students
students/{id}
students/{id}/custom
students/{id}/attendances
students/{id}/courseTranscripts
students/{id}/courseTranscripts/courses
students/{id}/reportCards
students/{id}/studentAcademicRecords
students/{id}/studentAssessments
students/{id}/studentAssessments/assessments
students/{id}/studentCohortAssociations
students/{id}/studentCohortAssociations/cohorts
students/{id}/studentDisciplineIncidentAssociations
students/{id}/studentDisciplineIncidentAssociations/disciplineIncidents
students/{id}/studentGradebookEntries
students/{id}/studentParentAssociations
students/{id}/studentParentAssociations/parents
students/{id}/studentProgramAssociations
students/{id}/studentProgramAssociations/programs
students/{id}/studentSchoolAssociations
students/{id}/studentSchoolAssociations/schools
students/{id}/studentSectionAssociations
students/{id}/studentSectionAssociations/sections
students/{id}/yearlyAttendances
teacherSchoolAssociations
teacherSchoolAssociations/{id}
teacherSchoolAssociations/{id}/custom
teacherSchoolAssociations/{id}/schools
teacherSchoolAssociations/{id}/teachers
teacherSectionAssociations
teacherSectionAssociations/{id}
teacherSectionAssociations/{id}/custom
teacherSectionAssociations/{id}/sections
teacherSectionAssociations/{id}/teachers
teachers
teachers/{id}
teachers/{id}/custom
teachers/{id}/disciplineActions
teachers/{id}/disciplineIncidents
teachers/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
teachers/{id}/staffCohortAssociations
teachers/{id}/staffCohortAssociations/cohorts
teachers/{id}/staffEducationOrgAssignmentAssociations
teachers/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
teachers/{id}/staffProgramAssociations
teachers/{id}/staffProgramAssociations/programs
teachers/{id}/teacherSchoolAssociations
teachers/{id}/teacherSchoolAssociations/schools
teachers/{id}/teacherSectionAssociations
teachers/{id}/teacherSectionAssociations/sections
yearlyAttendances
yearlyAttendances/{id}
yearlyAttendances/{id}/custom
Example Requests & Responses for inBloom REST API v1.1
API version 1.0: Data Resources
assessments
assessments/{id}
assessments/{id}/custom
assessments/{id}/learningObjectives
assessments/{id}/learningStandards
assessments/{id}/studentAssessments
attendances
attendances/{id}
attendances/{id}/custom
cohorts
cohorts/{id}
cohorts/{id}/custom
cohorts/{id}/staffCohortAssociations
cohorts/{id}/staffCohortAssociations/staff
cohorts/{id}/studentCohortAssociations
cohorts/{id}/studentCohortAssociations/students
competencyLevelDescriptor
competencyLevelDescriptor/{id}
competencyLevelDescriptor/{id}/custom
courseOfferings
courseOfferings/{id}
courseOfferings/{id}/custom
courseOfferings/{id}/courses
courseOfferings/{id}/sections
courseOfferings/{id}/sessions
courseTranscripts
courseTranscripts/{id}
courseTranscripts/{id}/custom
courseTranscripts/{id}/courses
courseTranscripts/{id}/students
courses
courses/{id}
courses/{id}/custom
courses/{id}/courseOfferings
courses/{id}/courseOfferings/sessions
courses/{id}/courseTranscripts
disciplineActions
disciplineActions/{id}
disciplineActions/{id}/custom
disciplineIncidents
disciplineIncidents/{id}
disciplineIncidents/{id}/custom
disciplineIncidents/{id}/studentDisciplineIncidentAssociations
disciplineIncidents/{id}/studentDisciplineIncidentAssociations/students
educationOrganizations
educationOrganizations/{id}
educationOrganizations/{id}/custom
educationOrganizations/{id}/calendarDates
educationOrganizations/{id}/cohorts
educationOrganizations/{id}/courses
educationOrganizations/{id}/educationOrganizations
educationOrganizations/{id}/graduationPlans
educationOrganizations/{id}/schools
educationOrganizations/{id}/sessions
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations
educationOrganizations/{id}/staffEducationOrgAssignmentAssociations/staff
educationOrganizations/{id}/studentCompetencyObjectives
gradebookEntries
gradebookEntries/{id}
gradebookEntries/{id}/custom
gradebookEntries/{id}/studentGradebookEntries
grades
grades/{id}
grades/{id}/custom
gradingPeriods
gradingPeriods/{id}
gradingPeriods/{id}/custom
gradingPeriods/{id}/calendarDates
gradingPeriods/{id}/grades
gradingPeriods/{id}/reportCards
graduationPlans
graduationPlans/{id}
graduationPlans/{id}/custom
home
learningObjectives
learningObjectives/{id}
learningObjectives/{id}/custom
learningObjectives/{id}/childLearningObjectives
learningObjectives/{id}/learningStandards
learningObjectives/{id}/parentLearningObjectives
learningObjectives/{id}/studentCompetencies
learningStandards
learningStandards/{id}
learningStandards/{id}/custom
parents
parents/{id}
parents/{id}/custom
parents/{id}/studentParentAssociations
parents/{id}/studentParentAssociations/students
programs
programs/{id}
programs/{id}/custom
programs/{id}/staffProgramAssociations
programs/{id}/staffProgramAssociations/staff
programs/{id}/studentProgramAssociations
programs/{id}/studentProgramAssociations/students
reportCards
reportCards/{id}
reportCards/{id}/custom
schools
schools/{id}
schools/{id}/custom
schools/{id}/courseOfferings
schools/{id}/courses
schools/{id}/graduationPlans
schools/{id}/sections
schools/{id}/sections/gradebookEntries
schools/{id}/sections/studentSectionAssociations
schools/{id}/sections/studentSectionAssociations/grades
schools/{id}/sections/studentSectionAssociations/studentCompetencies
schools/{id}/sessions
schools/{id}/sessions/gradingPeriods
schools/{id}/studentSchoolAssociations
schools/{id}/studentSchoolAssociations/students
schools/{id}/studentSchoolAssociations/students/attendances
schools/{id}/studentSchoolAssociations/students/courseTranscripts
schools/{id}/studentSchoolAssociations/students/reportCards
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords
schools/{id}/studentSchoolAssociations/students/studentAcademicRecords/courseTranscripts
schools/{id}/studentSchoolAssociations/students/studentAssessments
schools/{id}/studentSchoolAssociations/students/studentGradebookEntries
schools/{id}/studentSchoolAssociations/students/studentParentAssociations
schools/{id}/studentSchoolAssociations/students/studentParentAssociations/parents
schools/{id}/teacherSchoolAssociations
schools/{id}/teacherSchoolAssociations/teachers
schools/{id}/teacherSchoolAssociations/teachers/teacherSectionAssociations
sections
sections/{id}
sections/{id}/custom
sections/{id}/gradebookEntries
sections/{id}/studentGradebookEntries
sections/{id}/studentSectionAssociations
sections/{id}/studentSectionAssociations/grades
sections/{id}/studentSectionAssociations/studentCompetencies
sections/{id}/studentSectionAssociations/students
sections/{id}/studentSectionAssociations/students/attendances
sections/{id}/studentSectionAssociations/students/courseTranscripts
sections/{id}/studentSectionAssociations/students/reportCards
sections/{id}/studentSectionAssociations/students/studentAcademicRecords
sections/{id}/studentSectionAssociations/students/studentAcademicRecords/courseTranscripts
sections/{id}/studentSectionAssociations/students/studentAssessments
sections/{id}/studentSectionAssociations/students/studentGradebookEntries
sections/{id}/studentSectionAssociations/students/studentParentAssociations
sections/{id}/studentSectionAssociations/students/studentParentAssociations/parents
sections/{id}/studentSectionAssociations/students/studentSchoolAssociations
sections/{id}/studentSectionAssociations/students/yearlyAttendances
sections/{id}/teacherSectionAssociations
sections/{id}/teacherSectionAssociations/teachers
sessions
sessions/{id}
sessions/{id}/custom
sessions/{id}/courseOfferings
sessions/{id}/courseOfferings/courses
sessions/{id}/sections
sessions/{id}/studentAcademicRecords
staff
staff/{id}
staff/{id}/custom
staff/{id}/disciplineActions
staff/{id}/disciplineIncidents
staff/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
staff/{id}/staffCohortAssociations
staff/{id}/staffCohortAssociations/cohorts
staff/{id}/staffCohortAssociations/cohorts/studentCohortAssociations
staff/{id}/staffEducationOrgAssignmentAssociations
staff/{id}/staffEducationOrgAssignmentAssociations/educationOrganizations
staff/{id}/staffEducationOrgAssignmentAssociations/schools
staff/{id}/staffProgramAssociations
staff/{id}/staffProgramAssociations/programs
staff/{id}/staffProgramAssociations/programs/studentProgramAssociations
staffCohortAssociations
staffCohortAssociations/{id}
staffCohortAssociations/{id}/custom
staffCohortAssociations/{id}/cohorts
staffCohortAssociations/{id}/staff
staffEducationOrgAssignmentAssociations
staffEducationOrgAssignmentAssociations/{id}
staffEducationOrgAssignmentAssociations/{id}/custom
staffEducationOrgAssignmentAssociations/{id}/educationOrganizations
staffEducationOrgAssignmentAssociations/{id}/staff
staffProgramAssociations
staffProgramAssociations/{id}
staffProgramAssociations/{id}/custom
staffProgramAssociations/{id}/programs
staffProgramAssociations/{id}/staff
studentAcademicRecords
studentAcademicRecords/{id}
studentAcademicRecords/{id}/custom
studentAcademicRecords/{id}/courseTranscripts
studentAssessments
studentAssessments/{id}
studentAssessments/{id}/custom
studentAssessments/{id}/assessments
studentAssessments/{id}/students
studentCohortAssociations
studentCohortAssociations/{id}
studentCohortAssociations/{id}/custom
studentCohortAssociations/{id}/cohorts
studentCohortAssociations/{id}/students
studentCompetencies
studentCompetencies/{id}
studentCompetencies/{id}/custom
studentCompetencies/{id}/reportCards
studentCompetencyObjectives
studentCompetencyObjectives/{id}
studentCompetencyObjectives/{id}/custom
studentDisciplineIncidentAssociations
studentDisciplineIncidentAssociations/{id}
studentDisciplineIncidentAssociations/{id}/custom
studentDisciplineIncidentAssociations/{id}/disciplineIncidents
studentDisciplineIncidentAssociations/{id}/students
studentGradebookEntries
studentGradebookEntries/{id}
studentGradebookEntries/{id}/custom
studentParentAssociations
studentParentAssociations/{id}
studentParentAssociations/{id}/custom
studentParentAssociations/{id}/parents
studentParentAssociations/{id}/students
studentProgramAssociations
studentProgramAssociations/{id}
studentProgramAssociations/{id}/custom
studentProgramAssociations/{id}/programs
studentProgramAssociations/{id}/students
studentSchoolAssociations
studentSchoolAssociations/{id}
studentSchoolAssociations/{id}/custom
studentSchoolAssociations/{id}/schools
studentSchoolAssociations/{id}/students
studentSectionAssociations
studentSectionAssociations/{id}
studentSectionAssociations/{id}/custom
studentSectionAssociations/{id}/grades
studentSectionAssociations/{id}/sections
studentSectionAssociations/{id}/studentCompetencies
studentSectionAssociations/{id}/students
students
students/{id}
students/{id}/custom
students/{id}/attendances
students/{id}/courseTranscripts
students/{id}/courseTranscripts/courses
students/{id}/reportCards
students/{id}/studentAcademicRecords
students/{id}/studentAssessments
students/{id}/studentAssessments/assessments
students/{id}/studentCohortAssociations
students/{id}/studentCohortAssociations/cohorts
students/{id}/studentDisciplineIncidentAssociations
students/{id}/studentDisciplineIncidentAssociations/disciplineIncidents
students/{id}/studentGradebookEntries
students/{id}/studentParentAssociations
students/{id}/studentParentAssociations/parents
students/{id}/studentProgramAssociations
students/{id}/studentProgramAssociations/programs
students/{id}/studentSchoolAssociations
students/{id}/studentSchoolAssociations/schools
students/{id}/studentSectionAssociations
students/{id}/studentSectionAssociations/sections
students/{id}/yearlyAttendances
teacherSchoolAssociations
teacherSchoolAssociations/{id}
teacherSchoolAssociations/{id}/custom
teacherSchoolAssociations/{id}/schools
teacherSchoolAssociations/{id}/teachers
teacherSectionAssociations
teacherSectionAssociations/{id}
teacherSectionAssociations/{id}/custom
teacherSectionAssociations/{id}/sections
teacherSectionAssociations/{id}/teachers
teachers
teachers/{id}
teachers/{id}/custom
teachers/{id}/disciplineActions
teachers/{id}/disciplineIncidents
teachers/{id}/disciplineIncidents/studentDisciplineIncidentAssociations
teachers/{id}/staffCohortAssociations
teachers/{id}/staffCohortAssociations/cohorts
teachers/{id}/teacherSchoolAssociations
teachers/{id}/teacherSchoolAssociations/schools
teachers/{id}/teacherSectionAssociations
teachers/{id}/teacherSectionAssociations/sections
yearlyAttendances
yearlyAttendances/{id}
yearlyAttendances/{id}/custom
Example Requests & Responses for inBloom REST API v1.0
Deleted URIs
courses/{id}/courseTranscripts/students
assessments/{id}/studentAssessments/students
competencyLevelDescriptorTypes
competencyLevelDescriptorTypes/{id}
competencyLevelDescriptorTypes/{id}/custom
courses/{id}/studentParentAssociations
courses/{id}/studentParentAssociations/students
inBloom Overview
inBloom Architecture
inBloom Security
User Authentication in inBloom Technology
Core Concepts for User Authentication
Security and Administration Designations
Tenant and Realm
Federated and Hosted
inBloom Roles and Permissions
Assumptions about an Educational Organization
Default User Roles and Role Groups
How inBloom Determines Permissions
Default Permissions
Student Data Permissions
Permissions for Self
BULK_EXTRACT right
Integrated Authentication: inBloom Technology and Local Directory Services
The inBloom Authentication Strategy
Federated Authentication Strategy
inBloom Authentication Integration Procedure
Configure inBloom Technology to work with your IDP
Integrated inBloom Application Authentication
Effective Data Store Permissions for Federated Authentication
Mapping Directory Entities to the inBloom Data Store
Security Events
Security Events Tracked
Contextual Authorization Rules
Global Authorization Rules
Global Entities
Orphan Entities
Contextual Authorization: Staff
Staff Context Relies on Education Organization
Staff Context Expires When Association Ends
Staff Context with Student Data
Contextual Authorization: Teachers
Teacher Entity Must Have Certain Associations
Teacher Context Relies on Section, Cohort, or Program
Teacher Context Expires When Associations End
Contextual Authorization: Parents
Contextual Authorization: Students
Glossary