SylogistEd Student Information System API

API Help

The following is information on Authentication and definitions of the API route end-points.

Authentication Methods

There are two methods of authenticating to the API; Basic Authentication, JSON Web Token (JWT). For both methods, the school district will create a user and assign the appropriate roles to the user for the API Developer.

If the API Developer will use the Basic Authentication method, the school district must provide the Username and Password of the user to the API Developer. The API Developer will then pass their API Key and the Username and Password provided by the school district in the Authorization header of every HTTP Request.

If the API Developer will use the JSON Web Token method, there are two options for generating the JWT. The API Developer will then pass their JWT with every HTTP Request.

Generate JSON Web Token (JWT)

The school district will generate an encrypted User Lookup Value for the user and provide the User Lookup Value to the API Developer. The API Developer can then create a JWT using their API Key and the User Lookup Value from the school district. For this option, the school district does not have to provide the Username and Password to the API Developer.

Generate a JWT manually here: https://oked.sylogist.com/[SiteName]/account/developer

Generate a JWT from the API:

To request a JWT from the API, you will send a POST request to the following end-point.
https://oked.sylogist.com/[SiteName]StudentInformationServices/apiauth/createjwtfordeveloper

HTTP Request Header:
Accept: text/plain
Content-Type: application/json

HTTP Request Body:
apiKey: API Key
expiration: Specify the expiration date and time of the JWT according to the ISO 8601 standard

Example:

-Date: 2023-03-01
-Date and Time in UTC: 2023-03-01T13:54:33Z

userLookupValue: User Lookup Value provided by the school district

The response will include the JWT.

Revoke JWTs

The API Developer can revoke previously issued JWTs using their API Key and the User Lookup Value from the school district.

To revoke previously issued JWTs, you will send a POST request to the following end-point.
https://oked.sylogist.com/[SiteName]StudentInformationServices/apiauth/revoke

HTTP Request Body:
apiKey: API Key
userLookupValue: User Lookup Value provided by the school district

Basic Authentication

To authenticate with the Basic Authentication method, you must specify the API Key, Username, and Password in the Authorization header of every HTTP Request. This information must be base64-encoded.

Example:

-Access the Sites for the 2018 school year using the Basic Authentication method.
https://oked.sylogist.com/[SiteName]StudentInformationServices/api/Sites/2018

HTTP Request Header:
Authorization: Basic Username:Password:APIKey

JSON Web Token (JWT) Authentication

To authenticate with the JSON Web Token method, you must pass the JWT with every HTTP Request. The JWT can be passed as a Bearer query string parameter or by setting the Bearer in the Authorization header of the HTTP Request.

Example:

-Access the Sites for the 2018 school year using the JSON Web Token method as a query string parameter.
https://oked.sylogist.com/[SiteName]StudentInformationServices/api/Sites/2018?Bearer=<token>

-Access the Sites for the 2018 school year using the JSON Web Token method as the Bearer in the Authorization header of the HTTP Request.
https://oked.sylogist.com/[SiteName]StudentInformationServices/api/Sites/2018

HTTP Request Header:
Authorization: Bearer <token>

LEA

The LEA represents the local education agency. The user must have SIAPIUser role to use these methods.

API	Description
GET api/LEA	Returns the LEA.

Sites

The Site represents an instructional unit for the school district. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Sites/{SchoolYear}	Returns the Sites for a School Year.
GET api/Sites/{SiteId}	Returns a Site.

Courses

The Course represents a unit of instruction. The Course may be used in multiple Sites. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Courses/{SchoolYear}	Returns the Courses for the Sites in a School Year.
GET api/Courses/{CourseId}	Returns a Course.

Instructors

The Instructor may be used in multiple Sites. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Instructors/{SchoolYear}	Returns the Instructors for the Sites in a School Year.
GET api/Instructors/{InstructorId}	Returns an Instructor.

Sessions

The Session represents a reporting period for the Site. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Sites/{SiteId}/Sessions	Returns the Sessions for a Site.
GET api/Sessions/{SessionId}	Returns a Session.

GradingEvaluationSchedules

The Grading Evaluation Schedule represents a series of grade reporting periods for the Site. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Sites/{SiteId}/GradingEvaluationSchedules	Returns the Grading Evaluation Schedules for a Site.
GET api/GradingEvaluationSchedules/{GradingEvaluationScheduleId}	Returns a Grading Evaluation Schedule.
GET api/GradingEvaluationSchedules/{GradingEvaluationScheduleId}/Details	Returns the Grading Evaluation Schedule Details for a Grading Evaluation Schedule.
GET api/GradingEvaluationScheduleDetails/{GradingEvaluationScheduleDetailId}	Returns a Grading Evaluation Schedule Detail.

Sections

The Section identifies how a Course is taught in a Site. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Sites/{SiteId}/Sections	Returns the Sections for a Site.
GET api/Sections/{SectionId}	Returns a Section.

Students

The Student represents a Person enrolled in a Site. The user must have SIAPIUser and DemographicsReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/Students	Returns the Students for a Site.
GET api/Students/{SchoolYear}/{StudentId}	Returns a Student.

StudentRelationships

The Student Relationship represents a Person related to a Student. This could include guardians, emergency contacts, and other relationship types. The user must have SIAPIUser and DemographicsReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentRelationships	Returns the Student Relationships for a Site.
GET api/Sites/{SiteId}/StudentPrimaryGuardians	Returns the primary guardian Student Relationships for a Site. The primary guardian is a specific type of Student Relationship with the following indicators: ParentLegalGuardian or HasCustody = True, AccessToRecords = True.
GET api/StudentRelationships/{StudentRelationshipId}	Returns a Student Relationship.

StudentEnrollments

The enrollment information of the Student in a Site. The user must have SIAPIUser and DemographicsReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentEnrollments	Returns the Student Enrollments for a Site.
GET api/StudentEnrollments/{StudentEnrollmentId}	Returns a Student Enrollment.

StudentPeriodAttendance

The Student's Attendance recorded for a period on a date. The user must have SIAPIUser, DemographicsReader and AttendanceReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentPeriodAttendance	Returns the Student Period Attendance for a Site.
GET api/Sites/{SiteId}/StudentPeriodAttendance/{BeginDate}/{EndDate}	Returns the Student Period Attendance for a Site and date range.
GET api/Students/{SchoolYear}/{StudentId}/StudentPeriodAttendance	Returns the Student Period Attendance for a Student.
GET api/Students/{SchoolYear}/{StudentId}/StudentPeriodAttendance/{BeginDate}/{EndDate}	Returns the Student Period Attendance for a Student and date range.

StudentSectionEnrollments

The enrollment information of the Student in a Section. The user must have SIAPIUser, DemographicsReader and Activity/ScheduleReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentSectionEnrollments	Returns the Student Section Enrollments for a Site.
GET api/StudentSectionEnrollments/{StudentSectionEnrollmentId}	Returns a Student Section Enrollment.

StudentSectionGrades

The grade recorded for the Student in a Section. The user must have SIAPIUser, DemographicsReader and Assignment/Elig/GradesReader roles to use these methods. For the POST/PUT/DELETE methods, the user must have Elig/GradesReaderWriter role.

API	Description
GET api/Sites/{SiteId}/StudentSectionGrades	Returns the Student Section Grades for a Site.
GET api/Sections/{SectionId}/StudentSectionGrades	Returns the Student Section Grades for a Section.
GET api/Sections/{SectionId}/StudentSectionGrades/{GradingEvaluationScheduleDetailId}	Returns the Student Section Grades for a Section and Grading Evaluation Schedule Detail.
GET api/StudentSectionGrades/{StudentSectionGradeId}	Returns a Student Section Grade.
POST api/StudentSectionGrades	Creates a new Student Section Grade.
PUT api/StudentSectionGrades/{StudentSectionGradeId}	Updates an existing Student Section Grade.
DELETE api/StudentSectionGrades/{StudentSectionGradeId}	Deletes an existing Student Section Grade.

StudentFederal

The federally related program information of the Student. The user must have SIAPIUser, DemographicsReader and StudentFederalReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentFederal	Returns the Student Federal information for a Site.
GET api/Sites/{SiteId}/StudentFederal/{FederalCodeUid}	Returns the Student Federal information for a Site and Federal Code Uid.
GET api/Students/{SchoolYear}/{StudentId}/StudentFederal	Returns the Student Federal information for a Student.
GET api/Students/{SchoolYear}/{StudentId}/StudentFederal/{FederalCodeUid}	Returns the Student Federal information for a Student and Federal Code Uid.
GET api/StudentFederal/{StudentFederalId}	Returns a Student Federal.

AssignmentTypes

An Assignment Type for a Section's Section Group.

In the Instructor Gradebook application an Instructor can create Section Groups and assign Sections to a Section Group. Assignment Types added for one Section are available to all Sections in the Section Group.

The user must have SIAPIUser and Assignment/Elig/GradesReader roles to use these methods. For the POST/PUT/DELETE methods, the user must have Elig/GradesReaderWriter role.

API	Description
GET api/Sections/{SectionId}/AssignmentTypes	Returns the Assignment Types for a Section's Section Group.
GET api/AssignmentTypes/{AssignmentTypeId}	Returns an Assignment Type.
POST api/AssignmentTypes	Creates a new Assignment Type.
PUT api/AssignmentTypes/{AssignmentTypeId}	Updates an existing Assignment Type.
DELETE api/AssignmentTypes/{AssignmentTypeId}	Deletes an existing Assignment Type.

LessonPlans

A Lesson Plan for a Section.

In the Instructor Gradebook application an Instructor can create Lesson Plans for a Section Group, and assign Lesson Plans to Sections.

The user must have SIAPIUser and Assignment/Elig/GradesReader or Elig/GradesReaderWriter roles to use these methods.

API	Description
GET api/Sections/{SectionId}/LessonPlans	Returns the Lesson Plans for a Section.
GET api/LessonPlans/{LessonPlanId}	Returns a Lesson Plan.

Assignments

An Assignment for a Section's Lesson Plan.

The user must have SIAPIUser and Assignment/Elig/GradesReader roles to use these methods. For the POST/PUT/DELETE methods, the user must have Elig/GradesReaderWriter role.

API	Description
GET api/Sections/{SectionId}/Assignments	Returns the Assignments for a Section.
GET api/Sections/{SectionId}/LessonPlans/{LessonPlanId}/Assignments	Returns the Assignments for a Section's Lesson Plan.
GET api/Sections/{SectionId}/Assignments/{AssignmentId}	Returns a Section's Assignment.
POST api/Sections/{SectionId}/Assignments	Creates a new Assignment for a Section's Lesson Plan. If the Section is part of a Section Group, the Assignment will not automatically be included for other Sections in the Section Group. To add an existing Assignment to other Sections in the Section Group use the PUT method.
PUT api/Sections/{SectionId}/Assignments/{AssignmentId}	Updates an existing Assignment. To assign an existing Assignment that is part of the Section's Section Group and Lesson Plan, pass in the SectionId of the Section to be assigned. The Assigned Date and Due Date will only change the dates for the passed SectionId. All other values will change the Assignment for all Sections.
DELETE api/Sections/{SectionId}/Assignments/{AssignmentId}	Removes an existing Assignment from a Section. Assignments can only be deleted from the Lesson Plan through the Instructor Gradebook application. Removing an Assignment from one Section will not remove it from other Sections it has been included for in the Section Group.

AssignmentScores

The assignment score recorded for the Student in a Section.

The user must have SIAPIUser, DemographicsReader and Assignment/Elig/GradesReader roles to use these methods. For the POST/PUT/DELETE methods, the user must have Elig/GradesReaderWriter role.

API	Description
GET api/Sections/{SectionId}/AssignmentScores	Returns the Assignment Scores for a Section.
GET api/Sections/{SectionId}/Assignments/{AssignmentId}/AssignmentScores	Returns the Assignment Scores for a Section and Assignment.
GET api/AssignmentScores/{AssignmentScoreId}	Returns a Assignment Score.
POST api/AssignmentScores	Creates a new Assignment Score.
PUT api/AssignmentScores/{AssignmentScoreId}	Updates an existing Assignment Score.
DELETE api/AssignmentScores/{AssignmentScoreId}	Deletes an existing Assignment Score. This unassigns the Assignment from the Student.

StudentActivities

The activity data recorded for the Student in a Section. The user must have SIAPIUser, DemographicsReader and ActivityScheduleReader roles to use these methods.

API	Description
GET api/Sites/{SiteId}/StudentActivities	Returns the Student Activities for a Site.
GET api/StudentActivities/{StudentActivityId}	Returns a Student Activity.

Activities

The Activity identifies a student activity available in the LEA. The user must have SIAPIUser role to use these methods.

API	Description
GET api/Activities	Returns the Activities for a Site.
GET api/Activities/{ActivityId}	Returns a Activity.