AIM Web Services

<back to all web services

GetSchoolListRequest

GetSchoolList
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/GetSchoolList
GetSchoolListRequest Parameters:
NameParameterData TypeRequiredDescription
DistrictIdqueryintegerNoDistrict ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
GetSchoolListResponse Parameters:
NameParameterData TypeRequiredDescription
SchoolsformList<SchoolGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
SchoolGeneric Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SchoolNameformstringNo
DistrictformstringNo
AddressformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
PhoneformstringNo
TaxAuthformstringNo
DeliveryInfoformC2BDeliveryInfoNo
C2BDeliveryInfo Parameters:
NameParameterData TypeRequiredDescription
FirstDeliveryformDateTimeNo
DeliveryTimeformDateTimeNo
DeliveryThresholdformintNo
SundayDeliveryformboolNo
MondayDeliveryformboolNo
TuesdayDeliveryformboolNo
WednesdayDeliveryformboolNo
ThursdayDeliveryformboolNo
FridayDeliveryformboolNo
SaturdayDeliveryformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetSchoolList HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSchoolListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Schools xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:SchoolGeneric>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:DeliveryInfo>
        <d2p1:DeliveryThreshold>0</d2p1:DeliveryThreshold>
        <d2p1:DeliveryTime>0001-01-01T00:00:00</d2p1:DeliveryTime>
        <d2p1:FirstDelivery>0001-01-01T00:00:00</d2p1:FirstDelivery>
        <d2p1:FridayDelivery>false</d2p1:FridayDelivery>
        <d2p1:MondayDelivery>false</d2p1:MondayDelivery>
        <d2p1:SaturdayDelivery>false</d2p1:SaturdayDelivery>
        <d2p1:SundayDelivery>false</d2p1:SundayDelivery>
        <d2p1:ThursdayDelivery>false</d2p1:ThursdayDelivery>
        <d2p1:TuesdayDelivery>false</d2p1:TuesdayDelivery>
        <d2p1:WednesdayDelivery>false</d2p1:WednesdayDelivery>
      </d2p1:DeliveryInfo>
      <d2p1:District>String</d2p1:District>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:SchoolName>String</d2p1:SchoolName>
      <d2p1:State>String</d2p1:State>
      <d2p1:TaxAuth>String</d2p1:TaxAuth>
      <d2p1:Zip>String</d2p1:Zip>
    </d2p1:SchoolGeneric>
  </Schools>
</GetSchoolListResponse>