Introduction

AnalyticVue Web API built based on the REST standards. AnalyticVue API used built-in HTTP features like HTTP authentication and HTTP verbs. AnalyticVue API uses the HTTP Response codes to indicate API errors. AnalyticVue API returns Success or Error response in JSON format. AnalyticVue API will respond to requests done through HTTPS only.

Authentication

In the AnalyticVue WEB API authentication of client request over HTTP done through Token. This token is generated by WEB API server and every client Request will validate the token and performs the authentication. Every registered client /Tenant will have the token. The lifetime /validity of the token is 24 hrs. This can be configured based on the settings.

Every Tenant will have unique Token. Based on the Token information System will identify the Tenant

Data Limit

AnalyticVue Web API limits the Data entities /objects to 5000 per Request. To GET or PUT more Records pagination will be implemented.

LEA

URL Action Method Description
/LEA?pageNo=<pageNo> get Get all LEA(s)
/LEA?LEACode=<LEACode> get Get the LEA based on the code.

LEA fields

Field Name Field Type Is Required Description
LEACode string false LEACode
LEAName string false LEAName
OrganizationType string false OrganizationType
OperatingStatus string false OperatingStatus
LEAAddress string false LEAAddress
LEAContacts string false LEAContacts

School

URL Action Method Description
/School?pageNo=<pageNo> get Get all School(s)
/School?SchoolCode=<SchoolCode> get Get the School based on the code.

School fields

Field Name Field Type Is Required Description
SchoolCode string false SchoolCode
OrganizationName string false OrganizationName
OrganizationType string false OrganizationType
SchoolCode string false SchoolCode
Operating Status string false Operating Status
SchoolGrades string false SchoolGrades
SchoolAddress string false SchoolAddress

Student

URL Action Method Description
/K12Student?pageNo=<pageNo> get Get all Student(s)
/K12Student?StudentID=<StudentID> get Get the Student based on the code.

Student fields

Field Name Field Type Is Required Description
StudentId string false StudentId
FirstName string false FirstName
LastName string false LastName
Gender string false Gender
BirthDate string false BirthDate
Race string false Race
Ethinicity string false Ethinicity
SchoolId string false SchoolId
DistrictId string false DistrictId
GradeLevel string false GradeLevel
EnrollmentDate string false EnrollmentDate
StudentStateID string false StudentStateID
EnrollmentType string false EnrollmentType
ExitDate string false ExitDate
Exittype string false Exittype
SchoolYear string false SchoolYear

StudentSectionEnrollment

URL Action Method Description
/StudentSectionEnrollment?pageNo=<pageNo> get Get all Sections and students by School
/StudentSectionEnrollment ?StudentID=<StudentID> get Get all Sections for specific student by Student ID

Staff

URL Action Method Description
/K12Staff?pageNo=<pageNo> get Get all Staff(s)
/K12Staff ?StaffID=<StaffID> get Get the Staff based on the code.

SchoolsByCategory

URL Action Method Description
/SchoolsByCategory?pageNo=<pageNo> get Get all Schools info
/SchoolsByCategory ?SchoolCategoryCode=<SchoolCategoryCode> get Get the schools by the category sent

SchoolsByCategory Fields

Field Name Field Type Is Required Description
SchoolCode string false SchoolCode
OrganizationName string false OrganizationName
Organization Type string false Organization Type
LeaCode string false LeaCode
Operating Status string false Operating Status
SchoolGrades string false SchoolGrades
SchoolAddress string false SchoolAddress
SchoolCategory string false SchoolCategory

SectionEnrollment

URL Action Method Description
/SectionEnrollment?pageNo=<pageNo> get Get all Schools info
/SectionEnrollment ?SchoolCode=<SchoolCode> get Get the students based on schoolcode
/SectionEnrollment ?SchoolCode=<SchoolCode>&CourseCode=<CourseCode> get Get the students based on coursecode
/SectionEnrollment ?SchoolCode=<SchoolCode>&CourseCode=<CourseCode>&SectionCode=<SectionCode> get Get the students based on coursecode and sectioncode

SectionEnrollment Fields

Field Name Field Type Is Required Description
StudentId string false StudentId
Studentname string false Studentname
Startdate string false Startdate
EndDate string false EndDate
Grade string false Grade
Coursename string false Coursename
Sectionname string false SessionBeginDate
SessionEndDate string false SessionEndDate

StudentSections

URL Action Method Description
/StudentSections?pageNo=<pageNo> get Get the all sections from sectionEnrollment
/StudentSections ?SchoolCode=<SchoolCode>&StudentId=<StudentId> get Get the sections based on studentid from sectionEnrollment

StudentSections Fields

Field Name Field Type Is Required Description
StudentId string false StudentId
Studentname string false Studentname
Grade string false Grade
StaffName string false StaffName
Coursename string false Coursename
Sectionname string false Sectionname
SessionBeginDate string false SessionBeginDate
SessionEndDate string false SessionEndDate

CourseSections

URL Action Method Description
/CourseSections?pageNo=<pageNo> get Get all sections Info
/CourseSections?SchoolCode=<SchoolCode>&CourseCode=<CourseCode> get Get the sections based on coursecode and schoolcode
/CourseSections?SchoolCode=<SchoolCode> get Get the sections based on schoolcode

CourseSections Fields

Field Name Field Type Is Required Description
Schoolcode string false Schoolcode
Coursename string false Coursename
Sectionname string false Sectionname
SessionBeginDate string false SessionBeginDate
SessionEndDate string false SessionEndDate

StudentPrograms

URL Action Method Description
/StudentPrograms?pageNo=<pageNo> get Get all programs Info
/StudentPrograms?StudentId=<StudentId get Get the programs based on StudentId
/StudentPrograms?SchoolCode=<SchoolCode>&LEAcode=<LEAcode> get Get the programs based on schoolcode or leacode

StudentPrograms Fields

Field Name Field Type Is Required Description
StudentId string false StudentId
Schoolname string false Schoolname
Programcode string false Programcode
ProgramName string false ProgramName
StartDate string false StartDate
EndDate string false EndDate
ExitReason string false ExitReason

StaffAssignment

URL Action Method Description
/StaffAssignment?pageNo=<pageNo> get Get all Assignments Info
/StaffAssignment?StaffId=<StaffId get Get the Assignments info based on Staffid

StaffAssignment Fields

Field Name Field Type Is Required Description
StaffId string false StaffId
StaffName string false StaffName
SchoolName string false SchoolName
StartDate string false StartDate
EndDate string false EndDate

StaffSections

URL Action Method Description
/StaffSections?pageNo=<pageNo> get Get all sections Info
/StaffSections?StaffId=<StaffId get Get the sections based on StaffId
/StaffSections?SchoolCode=<SchoolCode>&StaffId=<StaffId> get Get the sections based on schoolcode or staffid

StaffSections Fields

Field Name Field Type Is Required Description
StaffId string false StaffId
StaffName string false StaffName
CourseName string false CourseName
SectionName string false SectionName
SessionBeginDate string false SessionBeginDate
SessionEndDate string false SessionEndDate

StudentCourses

URL Action Method Description
/studentcourses?StudentId=<StudentId> get Get the courses based on StudentId
/studentcourses?StudentId=<StudentId>&pageNo=<pageNo> get Get the courses based on StudentId and PageNo
/studentcourses?StudentId=<StudentId>&SchoolCode=<SchoolCode> get Get the courses based on StudentId and SchoolCode
/studentcourses?StudentId=<StudentId>&SchoolYear=<SchoolYear> get Get the Courses based on StudentId and SchoolYear

StudentCourses Fields

Field Name Field Type Is Required Description
StudentId string false StudentId
StudentName string false StudentName
SchoolCode string false SchoolCode
Grade string false Grade
CourseId string false CourseId
CourseName string false CourseName
CreditsAttempted string false CreditsAttempted
CreditsEarned string false CreditsEarned
SchoolYear string false SchoolYear

SchoolCourses

URL Action Method Description
/schoolcourses?SchoolCode=<SchoolCode> get Get the courses based on SchoolCode
/schoolcourses?SchoolCode=<SchoolCode>&pageNo=<pageNo> get Get the courses based on SchoolCode and PageNo
/schoolcourses?SchoolCode=<SchoolCode>&SchoolYear=<SchoolYear> get Get the courses based on SchoolCode and SchoolYear

SchoolCourses Fields

Field Name Field Type Is Required Description
LEACode string false LEACode
SchoolCode string false SchoolCode
CourseIdentifier string false CourseIdentifier
CourseTitle string false CourseTitle
SCEDCode string false SCEDCode
SubjectArea string false SubjectArea
GradeSpan string false GradeSpan
SchoolYear string false SchoolYear

DistrictCourses

URL Action Method Description
/districtcourses?LEACode=<LEACode> get Get the courses based on LEACode
/districtcourses?LEACode=<LEACode>pageNo=<pageNo> get Get the courses based on LEACode and PageNo
/districtcourses?LEACode=<LEACode>&SchoolYear=<SchoolYear> get Get the Courses based on LEACode and SchoolYear

DistrictCourses Fields

Field Name Field Type Is Required Description
LEACode string false LEACode
SchoolCode string false SchoolCode
CourseIdentifier string false CourseIdentifier
CourseTitle string false CourseTitle
SCEDCode string false SCEDCode
SubjectArea string false SubjectArea
GradeSpan string false GradeSpan
SchoolYear string false SchoolYear

SchoolPrograms

URL Action Method Description
/schoolprograms?SchoolCode=<SchoolCode> get Get the programs based on SchoolCode
/schoolprograms?SchoolCode=<SchoolCode>&pageNo=<pageNo> get Get the programs based on SchoolCode and PageNo
/schoolprograms?SchoolCode=<SchoolCode>&SchoolYear=<SchoolYear> get Get the programs based on SchoolCode and SchoolYear

SchoolPrograms Fields

Field Name Field Type Is Required Description
SchoolName string false SchoolName
ProgramCode string false ProgramCode
ProgramName string false ProgramName
StartDate string false StartDate
EndDate string false EndDate
SchoolYear string false SchoolYear

DistrictPrograms

URL Action Method Description
/districtprograms?LEACode=<LEACode> get Get the programs based on LEACode
/districtprograms?LEACode=<LEACode>&pageNo=<pageNo> get Get the programs based on LEACode and PageNo
/districtprograms?LEACode=<LEACode>&SchoolYear=<SchoolYear> get Get the programs based on LEACode and SchoolYear

DistrictPrograms Fields

Field Name Field Type Is Required Description
LEAName string false LEAName
SchoolName string false SchoolName
ProgramCode string false ProgramCode
ProgramName string false ProgramName
StartDate string false StartDate
EndDate string false EndDate
SchoolYear string false SchoolYear

OrganizationType Schools

URL Action Method Description
/orgtype?pageNo=<pageNo> get Get all Schools by Organization Type
/orgtype ?OrgtypeID=<OrgtypeID> get Get the Schools based on the Organization Type

Status Codes

Every API Call/Request will return status code and payload. While requesting/Calling the web API if any errors occurs it will return error message payload with response code

HTTP Code Meaning Description
200 Success If the Request is success, Web API will return the HTTP 200 and Payload
400 Bad Request While calling the API, If there is any error in the calling, API will throw HTTP 400 with error message.
401 Unauthorized If the request is sent without token/invalid token API will send the HTTP 401 as Authentication failed
404 Not found A request made for an entity, if the entity is not exists API will throw entity not found message.
Request sent for a School through GET or PUT, if the school not exists system will send HTTP 404 to the client.
405 Not Allowed A request made for an entity. The entity is read only (update or insert is not allowed) if the client sent a PUT or POST for the entity API will send HTTP 405.
406 Not Acceptable A request made for an entity has more records and the limit is not specified or limit is more than allowed API will send the HTTP 406
500 System Errors If there are any internal errors like DB or Web or Network, API will send HTTP 500.