CPS School Profile API

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

Request Information

URI Parameters

Name	Type	Additional information
SchoolID	string	Default value is
IsGoCPSParticipant	boolean	None.
GradeCategories	string	Default value is
ProgramIDs	string	Default value is
ProgramName	string	Default value is
IsPreSchool	boolean	None.
IsElementarySchool	boolean	None.
IsMiddleSchool	boolean	None.
IsHighSchool	boolean	None.
IsGoCPSPreK	boolean	None.
IsGoCPSES	boolean	None.
IsGoCPSHS	boolean	None.
Governances	string	Default value is
SchoolYear	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

GetGoCPSSchoolBasicReport_Result

Name	Type	Additional information
School_ID	integer	None.
Short_Name	string	None.
Long_Name	string	None.
School_Type	string	None.
Address	string	None.
City	string	None.
State	string	None.
Zip	string	None.
Phone	string	None.
Grades_Range	string	None.
Grades_Offered	string	None.
Student_Count_Total	string	None.
Overall_Rating	string	None.
Rating_Text	string	None.
Rating_Status	string	None.
Category	string	None.
Is_GoCPS_Participant	string	None.
Is_GoCPS_PreK	string	None.
Is_PreSchool	string	None.
Is_ElementarySchool	string	None.
Is_MiddleSchool	string	None.
Is_HighSchool	string	None.
Is_GoCPS_ES	string	None.
Is_GoCPS_HS	string	None.
Governance_Type	string	None.
Open_Date	date	None.
Close_Date	date	None.
Grades_Projected	string	None.
ProfileTemplate	string	None.
AgesServed	string	None.
SchoolYear	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "School_ID": 1,
  "Short_Name": "sample string 2",
  "Long_Name": "sample string 3",
  "School_Type": "sample string 4",
  "Address": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zip": "sample string 8",
  "Phone": "sample string 9",
  "Grades_Range": "sample string 10",
  "Grades_Offered": "sample string 11",
  "Student_Count_Total": "sample string 12",
  "Overall_Rating": "sample string 13",
  "Rating_Text": "sample string 14",
  "Rating_Status": "sample string 15",
  "Category": "sample string 16",
  "Is_GoCPS_Participant": "sample string 17",
  "Is_GoCPS_PreK": "sample string 18",
  "Is_PreSchool": "sample string 19",
  "Is_ElementarySchool": "sample string 20",
  "Is_MiddleSchool": "sample string 21",
  "Is_HighSchool": "sample string 22",
  "Is_GoCPS_ES": "sample string 23",
  "Is_GoCPS_HS": "sample string 24",
  "Governance_Type": "sample string 25",
  "Open_Date": "2023-03-20T08:29:52.2958625-05:00",
  "Close_Date": "2023-03-20T08:29:52.2958625-05:00",
  "Grades_Projected": "sample string 26",
  "ProfileTemplate": "sample string 27",
  "AgesServed": "sample string 28",
  "SchoolYear": 1
}

application/xml, text/xml

Sample:

<GetGoCPSSchoolBasicReport_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <Address>sample string 5</Address>
  <AgesServed>sample string 28</AgesServed>
  <Category>sample string 16</Category>
  <City>sample string 6</City>
  <Close_Date>2023-03-20T08:29:52.2958625-05:00</Close_Date>
  <Governance_Type>sample string 25</Governance_Type>
  <Grades_Offered>sample string 11</Grades_Offered>
  <Grades_Projected>sample string 26</Grades_Projected>
  <Grades_Range>sample string 10</Grades_Range>
  <Is_ElementarySchool>sample string 20</Is_ElementarySchool>
  <Is_GoCPS_ES>sample string 23</Is_GoCPS_ES>
  <Is_GoCPS_HS>sample string 24</Is_GoCPS_HS>
  <Is_GoCPS_Participant>sample string 17</Is_GoCPS_Participant>
  <Is_GoCPS_PreK>sample string 18</Is_GoCPS_PreK>
  <Is_HighSchool>sample string 22</Is_HighSchool>
  <Is_MiddleSchool>sample string 21</Is_MiddleSchool>
  <Is_PreSchool>sample string 19</Is_PreSchool>
  <Long_Name>sample string 3</Long_Name>
  <Open_Date>2023-03-20T08:29:52.2958625-05:00</Open_Date>
  <Overall_Rating>sample string 13</Overall_Rating>
  <Phone>sample string 9</Phone>
  <ProfileTemplate>sample string 27</ProfileTemplate>
  <Rating_Status>sample string 15</Rating_Status>
  <Rating_Text>sample string 14</Rating_Text>
  <SchoolYear>1</SchoolYear>
  <School_ID>1</School_ID>
  <School_Type>sample string 4</School_Type>
  <Short_Name>sample string 2</Short_Name>
  <State>sample string 7</State>
  <Student_Count_Total>sample string 12</Student_Count_Total>
  <Zip>sample string 8</Zip>
</GetGoCPSSchoolBasicReport_Result>