CPS School Profile API

GET CPS/GoCPSSchoolSearch?SearchTerm={SearchTerm}&Ratings={Ratings}&Categories={Categories}&ProgramGroups={ProgramGroups}

Search GoCPS schools

Request Information

URI Parameters

Name	Description	Type	Additional information
SearchTerm	optional. max size 255 characters.	string	Default value is
Ratings	optional. must be a comma-delimited string. "level 1,level 1+", "level 1" etc.	string	Default value is
Categories	optional. must be a comma-delimited string. "es,ms,hs,pk" are only valid options, but can be specified in any combination.	string	Default value is
ProgramGroups	optional. comma-delimited integers. list of program IDs to limit schools.	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of GetGoCPSSchoolSearch_Result

Name	Type	Additional information
School_ID	integer	None.
Short_Name	string	None.
Long_Name	string	None.
Street_Address	string	None.
City	string	None.
State	string	None.
Zip_Code	string	None.
Phone	string	None.
Fax	string	None.
Website_URL	string	None.
Grades_Range	string	None.
Grades_Offered_List	string	None.
Overall_Rating	string	None.
Is_Go_CPS	string	None.
Is_Go_CPS_PreK	string	None.
ActivityHealthWellness_List	string	None.
ActivityScholastic_List	string	None.
ActivityCommunity_List	string	None.
ActivitySports_List	string	None.
ActivityCollegeCareer_List	string	None.
ActivityCreative_List	string	None.
ActivityLifeLeadership_List	string	None.
School_Type	string	None.
Primary_Category	string	None.
ProgramType_List	string	None.
ProfileTemplate	string	None.
AgesServed	string	None.
SchoolYear	integer	None.
AMHours	string	None.
PMHours	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "School_ID": 1,
    "Short_Name": "sample string 2",
    "Long_Name": "sample string 3",
    "Street_Address": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip_Code": "sample string 7",
    "Phone": "sample string 8",
    "Fax": "sample string 9",
    "Website_URL": "sample string 10",
    "Grades_Range": "sample string 11",
    "Grades_Offered_List": "sample string 12",
    "Overall_Rating": "sample string 13",
    "Is_Go_CPS": "sample string 14",
    "Is_Go_CPS_PreK": "sample string 15",
    "ActivityHealthWellness_List": "sample string 16",
    "ActivityScholastic_List": "sample string 17",
    "ActivityCommunity_List": "sample string 18",
    "ActivitySports_List": "sample string 19",
    "ActivityCollegeCareer_List": "sample string 20",
    "ActivityCreative_List": "sample string 21",
    "ActivityLifeLeadership_List": "sample string 22",
    "School_Type": "sample string 23",
    "Primary_Category": "sample string 24",
    "ProgramType_List": "sample string 25",
    "ProfileTemplate": "sample string 26",
    "AgesServed": "sample string 27",
    "SchoolYear": 1,
    "AMHours": "sample string 28",
    "PMHours": "sample string 29"
  },
  {
    "School_ID": 1,
    "Short_Name": "sample string 2",
    "Long_Name": "sample string 3",
    "Street_Address": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip_Code": "sample string 7",
    "Phone": "sample string 8",
    "Fax": "sample string 9",
    "Website_URL": "sample string 10",
    "Grades_Range": "sample string 11",
    "Grades_Offered_List": "sample string 12",
    "Overall_Rating": "sample string 13",
    "Is_Go_CPS": "sample string 14",
    "Is_Go_CPS_PreK": "sample string 15",
    "ActivityHealthWellness_List": "sample string 16",
    "ActivityScholastic_List": "sample string 17",
    "ActivityCommunity_List": "sample string 18",
    "ActivitySports_List": "sample string 19",
    "ActivityCollegeCareer_List": "sample string 20",
    "ActivityCreative_List": "sample string 21",
    "ActivityLifeLeadership_List": "sample string 22",
    "School_Type": "sample string 23",
    "Primary_Category": "sample string 24",
    "ProgramType_List": "sample string 25",
    "ProfileTemplate": "sample string 26",
    "AgesServed": "sample string 27",
    "SchoolYear": 1,
    "AMHours": "sample string 28",
    "PMHours": "sample string 29"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetGoCPSSchoolSearch_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <GetGoCPSSchoolSearch_Result>
    <AMHours>sample string 28</AMHours>
    <ActivityCollegeCareer_List>sample string 20</ActivityCollegeCareer_List>
    <ActivityCommunity_List>sample string 18</ActivityCommunity_List>
    <ActivityCreative_List>sample string 21</ActivityCreative_List>
    <ActivityHealthWellness_List>sample string 16</ActivityHealthWellness_List>
    <ActivityLifeLeadership_List>sample string 22</ActivityLifeLeadership_List>
    <ActivityScholastic_List>sample string 17</ActivityScholastic_List>
    <ActivitySports_List>sample string 19</ActivitySports_List>
    <AgesServed>sample string 27</AgesServed>
    <City>sample string 5</City>
    <Fax>sample string 9</Fax>
    <Grades_Offered_List>sample string 12</Grades_Offered_List>
    <Grades_Range>sample string 11</Grades_Range>
    <Is_Go_CPS>sample string 14</Is_Go_CPS>
    <Is_Go_CPS_PreK>sample string 15</Is_Go_CPS_PreK>
    <Long_Name>sample string 3</Long_Name>
    <Overall_Rating>sample string 13</Overall_Rating>
    <PMHours>sample string 29</PMHours>
    <Phone>sample string 8</Phone>
    <Primary_Category>sample string 24</Primary_Category>
    <ProfileTemplate>sample string 26</ProfileTemplate>
    <ProgramType_List>sample string 25</ProgramType_List>
    <SchoolYear>1</SchoolYear>
    <School_ID>1</School_ID>
    <School_Type>sample string 23</School_Type>
    <Short_Name>sample string 2</Short_Name>
    <State>sample string 6</State>
    <Street_Address>sample string 4</Street_Address>
    <Website_URL>sample string 10</Website_URL>
    <Zip_Code>sample string 7</Zip_Code>
  </GetGoCPSSchoolSearch_Result>
  <GetGoCPSSchoolSearch_Result>
    <AMHours>sample string 28</AMHours>
    <ActivityCollegeCareer_List>sample string 20</ActivityCollegeCareer_List>
    <ActivityCommunity_List>sample string 18</ActivityCommunity_List>
    <ActivityCreative_List>sample string 21</ActivityCreative_List>
    <ActivityHealthWellness_List>sample string 16</ActivityHealthWellness_List>
    <ActivityLifeLeadership_List>sample string 22</ActivityLifeLeadership_List>
    <ActivityScholastic_List>sample string 17</ActivityScholastic_List>
    <ActivitySports_List>sample string 19</ActivitySports_List>
    <AgesServed>sample string 27</AgesServed>
    <City>sample string 5</City>
    <Fax>sample string 9</Fax>
    <Grades_Offered_List>sample string 12</Grades_Offered_List>
    <Grades_Range>sample string 11</Grades_Range>
    <Is_Go_CPS>sample string 14</Is_Go_CPS>
    <Is_Go_CPS_PreK>sample string 15</Is_Go_CPS_PreK>
    <Long_Name>sample string 3</Long_Name>
    <Overall_Rating>sample string 13</Overall_Rating>
    <PMHours>sample string 29</PMHours>
    <Phone>sample string 8</Phone>
    <Primary_Category>sample string 24</Primary_Category>
    <ProfileTemplate>sample string 26</ProfileTemplate>
    <ProgramType_List>sample string 25</ProgramType_List>
    <SchoolYear>1</SchoolYear>
    <School_ID>1</School_ID>
    <School_Type>sample string 23</School_Type>
    <Short_Name>sample string 2</Short_Name>
    <State>sample string 6</State>
    <Street_Address>sample string 4</Street_Address>
    <Website_URL>sample string 10</Website_URL>
    <Zip_Code>sample string 7</Zip_Code>
  </GetGoCPSSchoolSearch_Result>
</ArrayOfGetGoCPSSchoolSearch_Result>