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.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SearchValue

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Get School ID, School Name, Zip Codes that contain a requested search value. Numeric values will return Zip codes, while alphabetical will return school names.

SchoolProfileSearchAttributes
NameDescriptionTypeAdditional information
SchoolShortName

string

None.

SchoolLongName

string

None.

AddressZipCode

string

None.

AddressStreet

string

None.

AddressCity

string

None.

SchoolID

string

None.

Network

string

None.

Governance

string

None.

PrimaryCategory

string

None.

IsHighSchool

boolean

None.

IsMiddleSchool

boolean

None.

IsElementarySchool

boolean

None.

IsPreSchool

boolean

None.

IsGoCPSParticipant

boolean

None.

IsGoCPSPreK

boolean

None.

GradesOffered

string

None.

GradesOfferedReadable

string

None.

Rating

string

None.

RatingStatus

string

None.

RatingDescription

string

None.

OpenDate

date

None.

CloseDate

date

None.

Neighborhood

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SchoolShortName": "sample string 1",
  "SchoolLongName": "sample string 2",
  "AddressZipCode": "sample string 3",
  "AddressStreet": "sample string 4",
  "AddressCity": "sample string 5",
  "SchoolID": "sample string 6",
  "Network": "sample string 7",
  "Governance": "sample string 8",
  "PrimaryCategory": "sample string 9",
  "IsHighSchool": true,
  "IsMiddleSchool": true,
  "IsElementarySchool": true,
  "IsPreSchool": true,
  "IsGoCPSParticipant": true,
  "IsGoCPSPreK": true,
  "GradesOffered": "sample string 16",
  "GradesOfferedReadable": "sample string 17",
  "Rating": "sample string 18",
  "RatingStatus": "sample string 19",
  "RatingDescription": "sample string 20",
  "OpenDate": "2022-05-17T12:11:04.7030584-05:00",
  "CloseDate": "2022-05-17T12:11:04.7030584-05:00",
  "Neighborhood": "sample string 21"
}

application/xml, text/xml

Sample:
<SchoolProfileSearchAttributes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <AddressCity>sample string 5</AddressCity>
  <AddressStreet>sample string 4</AddressStreet>
  <AddressZipCode>sample string 3</AddressZipCode>
  <CloseDate>2022-05-17T12:11:04.7030584-05:00</CloseDate>
  <Governance>sample string 8</Governance>
  <GradesOffered>sample string 16</GradesOffered>
  <GradesOfferedReadable>sample string 17</GradesOfferedReadable>
  <IsElementarySchool>true</IsElementarySchool>
  <IsGoCPSParticipant>true</IsGoCPSParticipant>
  <IsGoCPSPreK>true</IsGoCPSPreK>
  <IsHighSchool>true</IsHighSchool>
  <IsMiddleSchool>true</IsMiddleSchool>
  <IsPreSchool>true</IsPreSchool>
  <Neighborhood>sample string 21</Neighborhood>
  <Network>sample string 7</Network>
  <OpenDate>2022-05-17T12:11:04.7030584-05:00</OpenDate>
  <PrimaryCategory>sample string 9</PrimaryCategory>
  <Rating>sample string 18</Rating>
  <RatingDescription>sample string 20</RatingDescription>
  <RatingStatus>sample string 19</RatingStatus>
  <SchoolID>sample string 6</SchoolID>
  <SchoolLongName>sample string 2</SchoolLongName>
  <SchoolShortName>sample string 1</SchoolShortName>
</SchoolProfileSearchAttributes>