CPS School Profile API

GET CPS/SchoolProfileBasicData?SchoolId={SchoolId}&IsGoCPSParticipant={IsGoCPSParticipant}&SchoolYear={SchoolYear}

Get School Profile Basic Data

Request Information

URI Parameters

Name	Type	Additional information
SchoolId	string	Default value is
IsGoCPSParticipant	string	Default value is
SchoolYear	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of GetSchoolBasicReport_Result

Name	Type	Additional information
School_ID	string	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_Offered	string	None.
Student_Count_Total	string	None.
Overall_Rating	string	None.
Rating_Text	string	None.
Rating_Status	string	None.
Is_GoCPS_Participant	string	None.
ProfileTemplate	string	None.
AgesServed	string	None.
SchoolYear	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "School_ID": "sample string 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_Offered": "sample string 10",
    "Student_Count_Total": "sample string 11",
    "Overall_Rating": "sample string 12",
    "Rating_Text": "sample string 13",
    "Rating_Status": "sample string 14",
    "Is_GoCPS_Participant": "sample string 15",
    "ProfileTemplate": "sample string 16",
    "AgesServed": "sample string 17",
    "SchoolYear": 1
  },
  {
    "School_ID": "sample string 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_Offered": "sample string 10",
    "Student_Count_Total": "sample string 11",
    "Overall_Rating": "sample string 12",
    "Rating_Text": "sample string 13",
    "Rating_Status": "sample string 14",
    "Is_GoCPS_Participant": "sample string 15",
    "ProfileTemplate": "sample string 16",
    "AgesServed": "sample string 17",
    "SchoolYear": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetSchoolBasicReport_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <GetSchoolBasicReport_Result>
    <Address>sample string 5</Address>
    <AgesServed>sample string 17</AgesServed>
    <City>sample string 6</City>
    <Grades_Offered>sample string 10</Grades_Offered>
    <Is_GoCPS_Participant>sample string 15</Is_GoCPS_Participant>
    <Long_Name>sample string 3</Long_Name>
    <Overall_Rating>sample string 12</Overall_Rating>
    <Phone>sample string 9</Phone>
    <ProfileTemplate>sample string 16</ProfileTemplate>
    <Rating_Status>sample string 14</Rating_Status>
    <Rating_Text>sample string 13</Rating_Text>
    <SchoolYear>1</SchoolYear>
    <School_ID>sample string 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 11</Student_Count_Total>
    <Zip>sample string 8</Zip>
  </GetSchoolBasicReport_Result>
  <GetSchoolBasicReport_Result>
    <Address>sample string 5</Address>
    <AgesServed>sample string 17</AgesServed>
    <City>sample string 6</City>
    <Grades_Offered>sample string 10</Grades_Offered>
    <Is_GoCPS_Participant>sample string 15</Is_GoCPS_Participant>
    <Long_Name>sample string 3</Long_Name>
    <Overall_Rating>sample string 12</Overall_Rating>
    <Phone>sample string 9</Phone>
    <ProfileTemplate>sample string 16</ProfileTemplate>
    <Rating_Status>sample string 14</Rating_Status>
    <Rating_Text>sample string 13</Rating_Text>
    <SchoolYear>1</SchoolYear>
    <School_ID>sample string 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 11</Student_Count_Total>
    <Zip>sample string 8</Zip>
  </GetSchoolBasicReport_Result>
</ArrayOfGetSchoolBasicReport_Result>