GET ims/oneroster/v1p1/School
Get array of School information for all schools in the district.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Get array of School information for all schools in the district.
Collection of SchoolAPIName | Description | Type | Additional information |
---|---|---|---|
SchoolCode | string |
None. |
|
SchoolName | string |
None. |
|
Address | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
Zipcode | string |
None. |
|
SchoolDistrictCode | string |
None. |
|
Building | string |
None. |
|
PhoneNumber | string |
None. |
|
EntryGrade | decimal number |
None. |
|
ExitGrade | decimal number |
None. |
|
PromotionGrade | decimal number |
None. |
|
SchoolTypeCode | string |
None. |
|
isDO | decimal number |
None. |
|
SchoolYear | decimal number |
None. |
|
Principal | string |
None. |
|
MainTrackCode | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "SchoolCode": "sample string 1", "SchoolName": "sample string 2", "Address": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zipcode": "sample string 6", "SchoolDistrictCode": "sample string 7", "Building": "sample string 8", "PhoneNumber": "sample string 9", "EntryGrade": 10.0, "ExitGrade": 11.0, "PromotionGrade": 12.0, "SchoolTypeCode": "sample string 13", "isDO": 14.0, "SchoolYear": 15.0, "Principal": "sample string 16", "MainTrackCode": "sample string 17" }, { "SchoolCode": "sample string 1", "SchoolName": "sample string 2", "Address": "sample string 3", "City": "sample string 4", "State": "sample string 5", "Zipcode": "sample string 6", "SchoolDistrictCode": "sample string 7", "Building": "sample string 8", "PhoneNumber": "sample string 9", "EntryGrade": 10.0, "ExitGrade": 11.0, "PromotionGrade": 12.0, "SchoolTypeCode": "sample string 13", "isDO": 14.0, "SchoolYear": 15.0, "Principal": "sample string 16", "MainTrackCode": "sample string 17" } ]
application/xml, text/xml
Sample:
<ArrayOfSchoolAPI xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SchoolAPI> <SchoolCode>sample string 1</SchoolCode> <SchoolName>sample string 2</SchoolName> <Address>sample string 3</Address> <City>sample string 4</City> <State>sample string 5</State> <Zipcode>sample string 6</Zipcode> <SchoolDistrictCode>sample string 7</SchoolDistrictCode> <Building>sample string 8</Building> <PhoneNumber>sample string 9</PhoneNumber> <EntryGrade>10</EntryGrade> <ExitGrade>11</ExitGrade> <PromotionGrade>12</PromotionGrade> <SchoolTypeCode>sample string 13</SchoolTypeCode> <isDO>14</isDO> <SchoolYear>15</SchoolYear> <Principal>sample string 16</Principal> <MainTrackCode>sample string 17</MainTrackCode> </SchoolAPI> <SchoolAPI> <SchoolCode>sample string 1</SchoolCode> <SchoolName>sample string 2</SchoolName> <Address>sample string 3</Address> <City>sample string 4</City> <State>sample string 5</State> <Zipcode>sample string 6</Zipcode> <SchoolDistrictCode>sample string 7</SchoolDistrictCode> <Building>sample string 8</Building> <PhoneNumber>sample string 9</PhoneNumber> <EntryGrade>10</EntryGrade> <ExitGrade>11</ExitGrade> <PromotionGrade>12</PromotionGrade> <SchoolTypeCode>sample string 13</SchoolTypeCode> <isDO>14</isDO> <SchoolYear>15</SchoolYear> <Principal>sample string 16</Principal> <MainTrackCode>sample string 17</MainTrackCode> </SchoolAPI> </ArrayOfSchoolAPI>