CPS School Profile API

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.

Request Information

URI Parameters

Name	Description	Type	Additional information
SchoolID	Optional, and must be an integer.	integer	Default value is 0
Year	Optional, and must be an integer.Default value is current fiscal year.	integer	Default value is 0
IsActive	Optional(true or false).Default value is true.	boolean	Default value is True
Program	Optional	string	Default value is
ProgramGroup	Optional	string	Default value is
Type	Optional	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of SchoolAdmissionProgramAttributes

Name	Type	Additional information
Year	string	None.
ProgramCode	string	None.
Attendance	string	None.
SchoolID	string	None.
MaxGradeServedProgram	string	None.
MaxGradeServedSchool	string	None.
MinGradeServedProgram	string	None.
MinGradeServedSchool	string	None.
ProgramName	string	None.
ActiveStatusName	boolean	None.
ProgramType	string	None.
ProgramGroup	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Year": "sample string 1",
    "ProgramCode": "sample string 2",
    "Attendance": "sample string 3",
    "SchoolID": "sample string 4",
    "MaxGradeServedProgram": "sample string 5",
    "MaxGradeServedSchool": "sample string 6",
    "MinGradeServedProgram": "sample string 7",
    "MinGradeServedSchool": "sample string 8",
    "ProgramName": "sample string 9",
    "ActiveStatusName": true,
    "ProgramType": "sample string 11",
    "ProgramGroup": "sample string 12"
  },
  {
    "Year": "sample string 1",
    "ProgramCode": "sample string 2",
    "Attendance": "sample string 3",
    "SchoolID": "sample string 4",
    "MaxGradeServedProgram": "sample string 5",
    "MaxGradeServedSchool": "sample string 6",
    "MinGradeServedProgram": "sample string 7",
    "MinGradeServedSchool": "sample string 8",
    "ProgramName": "sample string 9",
    "ActiveStatusName": true,
    "ProgramType": "sample string 11",
    "ProgramGroup": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSchoolAdmissionProgramAttributes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <SchoolAdmissionProgramAttributes>
    <ActiveStatusName>true</ActiveStatusName>
    <Attendance>sample string 3</Attendance>
    <MaxGradeServedProgram>sample string 5</MaxGradeServedProgram>
    <MaxGradeServedSchool>sample string 6</MaxGradeServedSchool>
    <MinGradeServedProgram>sample string 7</MinGradeServedProgram>
    <MinGradeServedSchool>sample string 8</MinGradeServedSchool>
    <ProgramCode>sample string 2</ProgramCode>
    <ProgramGroup>sample string 12</ProgramGroup>
    <ProgramName>sample string 9</ProgramName>
    <ProgramType>sample string 11</ProgramType>
    <SchoolID>sample string 4</SchoolID>
    <Year>sample string 1</Year>
  </SchoolAdmissionProgramAttributes>
  <SchoolAdmissionProgramAttributes>
    <ActiveStatusName>true</ActiveStatusName>
    <Attendance>sample string 3</Attendance>
    <MaxGradeServedProgram>sample string 5</MaxGradeServedProgram>
    <MaxGradeServedSchool>sample string 6</MaxGradeServedSchool>
    <MinGradeServedProgram>sample string 7</MinGradeServedProgram>
    <MinGradeServedSchool>sample string 8</MinGradeServedSchool>
    <ProgramCode>sample string 2</ProgramCode>
    <ProgramGroup>sample string 12</ProgramGroup>
    <ProgramName>sample string 9</ProgramName>
    <ProgramType>sample string 11</ProgramType>
    <SchoolID>sample string 4</SchoolID>
    <Year>sample string 1</Year>
  </SchoolAdmissionProgramAttributes>
</ArrayOfSchoolAdmissionProgramAttributes>