CPS
| API | Description |
|---|---|
| GET CPS/GoCPSFAQs |
returns all GoCPS FAQ libraries |
| GET CPS/TypeaheadSchoolSearch?SearchValue={SearchValue} |
Get list of school short names or zip codes that match a search value. Entire district will be returned for a blank or missing search value. |
| GET CPS/SingleSchoolProfile?SchoolID={SchoolID} |
Get a single school's profile data. Includes links to all profile report documentation. |
| GET CPS/FiscalYear |
No documentation available. |
| GET CPS/AllSchoolProfiles |
Get entire district's school profile data - if not requesting this as JSON, it can take some time to download all data. Payload estimate is ~900k of data. |
| GET CPS/SchoolComparison?SchoolIDs={SchoolIDs} |
Returns list of schools for side-by-side comparison. no school ID list maximum size, but keep value under 1024 characters for performance consideration. All school IDs must be numeric and delimited by a comma. |
| GET CPS/SchoolAdmissionProgram?SchoolID={SchoolID}&Year={Year}&IsActive={IsActive}&Program={Program}&ProgramGroup={ProgramGroup}&Type={Type} |
Returns list of School Admission programs. If no parameter is specified it returns all programs for all schools. To reduce the list filter by SchoolID,Year, Status, Program, Program Group and/or Type. |
| GET CPS/SchoolAdmissionProgramGroup?Year={Year}&IsActive={IsActive} |
Returns distinct School Admission program Groups. If no parameter is specified it returns all program groups. To reduce the list filter by Year and/or Status |
| GET CPS/SchoolAdmissionProgramType?Year={Year}&IsActive={IsActive} |
Returns distinct School Admission Program Types. If no parameter is specified it returns all program types. To reduce the list filter by Year and/or Status |
| GET CPS/SchoolAdmissionProgramNames?Year={Year}&IsActive={IsActive} |
Returns distinct School Admission Program Names. If no parameter is specified it returns all program names. To reduce the list filter by Year and/or Status |
| GET CPS/SchoolAdmissionProgramYears?IsActive={IsActive} |
Returns distinct School Admission Program Years. If no parameter is specified it returns all program years. To reduce the list filter by Status |
| GET CPS/AllSchoolAdmissionProgramGroup |
Returns All distinct School Admission Program Groups. |
| GET CPS/AllSchoolAdmissionProgramType |
Returns All distinct School Admission Program Types. |
| GET CPS/AllSchoolAdmissionProgramNames |
Returns All distinct School Admission Program Names. |
| GET CPS/AllSchoolAdmissionProgramYears |
Returns All distinct School Admission Program Years. |
| GET CPS/SchoolProfileInformation?SchoolId={SchoolId}&SchoolYear={SchoolYear} |
Get School Profile Information |
| GET CPS/SchoolProgressReport?SchoolId={SchoolId} |
Get School Progress Report Information |
| GET CPS/SchoolAdmissionsReport?SchoolId={SchoolId}&SchoolYear={SchoolYear} |
Get School Admissions report |
| GET CPS/SchoolDownloadsReport?SchoolId={SchoolId} |
Get School Downloads report |
| GET CPS/SchoolProfileBasicData?SchoolId={SchoolId}&IsGoCPSParticipant={IsGoCPSParticipant}&SchoolYear={SchoolYear} |
Get School Profile Basic Data |
| GET CPS/SchoolProfileCompleteData?SchoolId={SchoolId} |
No documentation available. |
| GET CPS/ProgramTypes?Program_ID={Program_ID}&Program_Type={Program_Type}&School_Program_Year={School_Program_Year} |
Get Active School Programs for input parameters. |
| GET CPS/GoCPSSchoolBasicReport?SchoolID={SchoolID}&IsGoCPSParticipant={IsGoCPSParticipant}&GradeCategories={GradeCategories}&ProgramIDs={ProgramIDs}&ProgramName={ProgramName}&IsPreSchool={IsPreSchool}&IsElementarySchool={IsElementarySchool}&IsMiddleSchool={IsMiddleSchool}&IsHighSchool={IsHighSchool}&IsGoCPSPreK={IsGoCPSPreK}&IsGoCPSES={IsGoCPSES}&IsGoCPSHS={IsGoCPSHS}&Governances={Governances}&SchoolYear={SchoolYear} |
Get GoCPS School Basic Report |
| GET CPS/SchoolComparisonForSchoolIDs?SchoolIDs={SchoolIDs} |
Returns list of schools for side-by-side comparison. no school ID list maximum size, but keep value under 1024 characters for performance consideration. |
| GET CPS/GoCPSSchoolSearch?SearchTerm={SearchTerm}&Ratings={Ratings}&Categories={Categories}&ProgramGroups={ProgramGroups} |
Search GoCPS schools |
| GET CPS/GoCPSFAQDetail?ReferenceID={ReferenceID} |
Get structure of all faq for a given reference ID. structure is a tree, with sub-nodes as nested lists |
| GET CPS/SearchSchoolNameOrZip?SearchValue={SearchValue} |
Get list of school short names or zip codes that match a search value. No results will be returned for a blank or missing search value. |
| GET CPS/ProfileBadges?SchoolID={SchoolID}&Year={Year} |
Get school profile badge attributes for a provided school ID and school year. |
GoCPS
| API | Description |
|---|---|
| GET GoCPS/FAQ |
Returns list of all go.cps.edu FAQ information |
| GET GoCPS/Glossary |
Returns Glossary of all go.cps.edu terms |
ECE
| API | Description |
|---|---|
| GET ECE/GetECESchoolData?SchoolCode={SchoolCode}&EnrollmentYear={EnrollmentYear} |
Get Early Childhood data from the City |
| GET ECE/GetECECPSSchoolData?SchoolCode={SchoolCode}&EnrollmentYear={EnrollmentYear} |
Get CPS PreK Data |
ProgramAdmissions
| API | Description |
|---|---|
| GET ProgramAdmissions/SchoolAdmissionProgram?SchoolID={SchoolID}&Year={Year}&Status={Status} |
Returns list of School Admission programs. If no parameter is specified it returns all programs for all schools. To reduce the list filter by SchoolID,Year and/or Status |
| GET ProgramAdmissions/SchoolAdmissionProgramGroup?Year={Year}&Status={Status} |
Returns distinct School Admission program groups. If no parameter is specified it returns all program groups. To reduce the list filter by Year and/or Status |
| GET ProgramAdmissions/SchoolAdmissionProgramType?Year={Year}&Status={Status} |
Returns distinct School Admission Program Types. If no parameter is specified it returns all program types. To reduce the list filter by Year and/or Status |