GET CPS/SingleNetworkProfile?NetworkName={NetworkName}&NetworkKeyID={NetworkKeyID}
Return list of all schools that belong to a requested network. NetworkName can either be given as full name or as network id. ex:"NETWORK 5" or "5" Network key ID is an int parameter provided by the AllNetworkProfiles function.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
NetworkName | string |
Default value is |
|
NetworkKeyID | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
SchoolNetwork record, which includes a list of BasicSchoolProfile records.
SchoolNetworkName | Description | Type | Additional information |
---|---|---|---|
NetworkKeyID | integer |
None. |
|
NetworkLongName | string |
None. |
|
NetworkShortName | string |
None. |
|
Description | string |
None. |
|
NetworkType | string |
None. |
|
NetworkSchools | Collection of BasicSchoolProfile |
None. |
Response Formats
application/json, text/json
Sample:
{ "NetworkSchools": [ { "SchoolID": 1, "SchoolShortName": "sample string 2", "SchoolLongName": "sample string 3", "Network": "sample string 4", "Governance": "sample string 5", "PrimaryCategory": "sample string 6", "AddressStreet": "sample string 7", "AddressCity": "sample string 8", "AddressZipCode": "sample string 9", "AddressLatitude": "sample string 10", "AddressLongitude": "sample string 11", "Phone": "sample string 12", "WebsiteURL": "sample string 13", "TwitterURL": "sample string 14", "FacebookURL": "sample string 15", "PinterestURL": "sample string 16", "YoutubeURL": "sample string 17", "IsHighSchool": true, "IsMiddleSchool": true, "IsElementarySchool": true, "IsPreSchool": true, "GradesOffered": "sample string 18", "GradesOfferedReadable": "sample string 19", "OpenDate": "2024-10-09T05:08:09.6098938-05:00", "CloseDate": "2024-10-09T05:08:09.6098938-05:00", "SchoolProfileYear": 1, "ProfileTemplate": "sample string 20", "ProgramsSummer": "sample string 21", "AgesServed": "sample string 22", "ProgramsSummerInstructional": "sample string 23", "AMHours": "sample string 24", "PMHours": "sample string 25" }, { "SchoolID": 1, "SchoolShortName": "sample string 2", "SchoolLongName": "sample string 3", "Network": "sample string 4", "Governance": "sample string 5", "PrimaryCategory": "sample string 6", "AddressStreet": "sample string 7", "AddressCity": "sample string 8", "AddressZipCode": "sample string 9", "AddressLatitude": "sample string 10", "AddressLongitude": "sample string 11", "Phone": "sample string 12", "WebsiteURL": "sample string 13", "TwitterURL": "sample string 14", "FacebookURL": "sample string 15", "PinterestURL": "sample string 16", "YoutubeURL": "sample string 17", "IsHighSchool": true, "IsMiddleSchool": true, "IsElementarySchool": true, "IsPreSchool": true, "GradesOffered": "sample string 18", "GradesOfferedReadable": "sample string 19", "OpenDate": "2024-10-09T05:08:09.6098938-05:00", "CloseDate": "2024-10-09T05:08:09.6098938-05:00", "SchoolProfileYear": 1, "ProfileTemplate": "sample string 20", "ProgramsSummer": "sample string 21", "AgesServed": "sample string 22", "ProgramsSummerInstructional": "sample string 23", "AMHours": "sample string 24", "PMHours": "sample string 25" } ], "NetworkKeyID": 1, "NetworkLongName": "sample string 2", "NetworkShortName": "sample string 3", "Description": "sample string 4", "NetworkType": "sample string 5" }
application/xml, text/xml
Sample:
<SchoolNetwork xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <NetworkSchools> <BasicSchoolProfile> <SchoolID>1</SchoolID> <SchoolShortName>sample string 2</SchoolShortName> <SchoolLongName>sample string 3</SchoolLongName> <Network>sample string 4</Network> <Governance>sample string 5</Governance> <PrimaryCategory>sample string 6</PrimaryCategory> <AddressStreet>sample string 7</AddressStreet> <AddressCity>sample string 8</AddressCity> <AddressZipCode>sample string 9</AddressZipCode> <AddressLatitude>sample string 10</AddressLatitude> <AddressLongitude>sample string 11</AddressLongitude> <Phone>sample string 12</Phone> <WebsiteURL>sample string 13</WebsiteURL> <TwitterURL>sample string 14</TwitterURL> <FacebookURL>sample string 15</FacebookURL> <PinterestURL>sample string 16</PinterestURL> <YoutubeURL>sample string 17</YoutubeURL> <IsHighSchool>true</IsHighSchool> <IsMiddleSchool>true</IsMiddleSchool> <IsElementarySchool>true</IsElementarySchool> <IsPreSchool>true</IsPreSchool> <GradesOffered>sample string 18</GradesOffered> <GradesOfferedReadable>sample string 19</GradesOfferedReadable> <OpenDate>2024-10-09T05:08:09.6098938-05:00</OpenDate> <CloseDate>2024-10-09T05:08:09.6098938-05:00</CloseDate> <SchoolProfileYear>1</SchoolProfileYear> <ProfileTemplate>sample string 20</ProfileTemplate> <ProgramsSummer>sample string 21</ProgramsSummer> <AgesServed>sample string 22</AgesServed> <ProgramsSummerInstructional>sample string 23</ProgramsSummerInstructional> <AMHours>sample string 24</AMHours> <PMHours>sample string 25</PMHours> </BasicSchoolProfile> <BasicSchoolProfile> <SchoolID>1</SchoolID> <SchoolShortName>sample string 2</SchoolShortName> <SchoolLongName>sample string 3</SchoolLongName> <Network>sample string 4</Network> <Governance>sample string 5</Governance> <PrimaryCategory>sample string 6</PrimaryCategory> <AddressStreet>sample string 7</AddressStreet> <AddressCity>sample string 8</AddressCity> <AddressZipCode>sample string 9</AddressZipCode> <AddressLatitude>sample string 10</AddressLatitude> <AddressLongitude>sample string 11</AddressLongitude> <Phone>sample string 12</Phone> <WebsiteURL>sample string 13</WebsiteURL> <TwitterURL>sample string 14</TwitterURL> <FacebookURL>sample string 15</FacebookURL> <PinterestURL>sample string 16</PinterestURL> <YoutubeURL>sample string 17</YoutubeURL> <IsHighSchool>true</IsHighSchool> <IsMiddleSchool>true</IsMiddleSchool> <IsElementarySchool>true</IsElementarySchool> <IsPreSchool>true</IsPreSchool> <GradesOffered>sample string 18</GradesOffered> <GradesOfferedReadable>sample string 19</GradesOfferedReadable> <OpenDate>2024-10-09T05:08:09.6098938-05:00</OpenDate> <CloseDate>2024-10-09T05:08:09.6098938-05:00</CloseDate> <SchoolProfileYear>1</SchoolProfileYear> <ProfileTemplate>sample string 20</ProfileTemplate> <ProgramsSummer>sample string 21</ProgramsSummer> <AgesServed>sample string 22</AgesServed> <ProgramsSummerInstructional>sample string 23</ProgramsSummerInstructional> <AMHours>sample string 24</AMHours> <PMHours>sample string 25</PMHours> </BasicSchoolProfile> </NetworkSchools> <NetworkKeyID>1</NetworkKeyID> <NetworkLongName>sample string 2</NetworkLongName> <NetworkShortName>sample string 3</NetworkShortName> <Description>sample string 4</Description> <NetworkType>sample string 5</NetworkType> </SchoolNetwork>