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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetSchoolListRequires active-e Customer Service.
    */
    @DataContract
    public static class GetSchoolListRequest extends BaseSecureRequest
    {
        /**
        * District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.", Format="int64", Name="DistrictId", ParameterType="query")
        public Long DistrictId = null;
        
        public Long getDistrictId() { return DistrictId; }
        public GetSchoolListRequest setDistrictId(Long value) { this.DistrictId = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class GetSchoolListResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<SchoolGeneric> Schools = null;
        
        public ArrayList<SchoolGeneric> getSchools() { return Schools; }
        public GetSchoolListResponse setSchools(ArrayList<SchoolGeneric> value) { this.Schools = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class SchoolGeneric
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String SchoolName = null;

        @DataMember
        public String District = null;

        @DataMember
        public String Address = null;

        @DataMember
        public String City = null;

        @DataMember
        public String State = null;

        @DataMember
        public String Zip = null;

        @DataMember
        public String Phone = null;

        @DataMember
        public String TaxAuth = null;

        @DataMember
        public C2BDeliveryInfo DeliveryInfo = null;
        
        public Long getId() { return Id; }
        public SchoolGeneric setId(Long value) { this.Id = value; return this; }
        public String getSchoolName() { return SchoolName; }
        public SchoolGeneric setSchoolName(String value) { this.SchoolName = value; return this; }
        public String getDistrict() { return District; }
        public SchoolGeneric setDistrict(String value) { this.District = value; return this; }
        public String getAddress() { return Address; }
        public SchoolGeneric setAddress(String value) { this.Address = value; return this; }
        public String getCity() { return City; }
        public SchoolGeneric setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public SchoolGeneric setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public SchoolGeneric setZip(String value) { this.Zip = value; return this; }
        public String getPhone() { return Phone; }
        public SchoolGeneric setPhone(String value) { this.Phone = value; return this; }
        public String getTaxAuth() { return TaxAuth; }
        public SchoolGeneric setTaxAuth(String value) { this.TaxAuth = value; return this; }
        public C2BDeliveryInfo getDeliveryInfo() { return DeliveryInfo; }
        public SchoolGeneric setDeliveryInfo(C2BDeliveryInfo value) { this.DeliveryInfo = value; return this; }
    }

    @DataContract
    public static class C2BDeliveryInfo
    {
        @DataMember
        public Date FirstDelivery = null;

        @DataMember
        public Date DeliveryTime = null;

        @DataMember
        public Integer DeliveryThreshold = null;

        @DataMember
        public Boolean SundayDelivery = null;

        @DataMember
        public Boolean MondayDelivery = null;

        @DataMember
        public Boolean TuesdayDelivery = null;

        @DataMember
        public Boolean WednesdayDelivery = null;

        @DataMember
        public Boolean ThursdayDelivery = null;

        @DataMember
        public Boolean FridayDelivery = null;

        @DataMember
        public Boolean SaturdayDelivery = null;
        
        public Date getFirstDelivery() { return FirstDelivery; }
        public C2BDeliveryInfo setFirstDelivery(Date value) { this.FirstDelivery = value; return this; }
        public Date getDeliveryTime() { return DeliveryTime; }
        public C2BDeliveryInfo setDeliveryTime(Date value) { this.DeliveryTime = value; return this; }
        public Integer getDeliveryThreshold() { return DeliveryThreshold; }
        public C2BDeliveryInfo setDeliveryThreshold(Integer value) { this.DeliveryThreshold = value; return this; }
        public Boolean isSundayDelivery() { return SundayDelivery; }
        public C2BDeliveryInfo setSundayDelivery(Boolean value) { this.SundayDelivery = value; return this; }
        public Boolean isMondayDelivery() { return MondayDelivery; }
        public C2BDeliveryInfo setMondayDelivery(Boolean value) { this.MondayDelivery = value; return this; }
        public Boolean isTuesdayDelivery() { return TuesdayDelivery; }
        public C2BDeliveryInfo setTuesdayDelivery(Boolean value) { this.TuesdayDelivery = value; return this; }
        public Boolean isWednesdayDelivery() { return WednesdayDelivery; }
        public C2BDeliveryInfo setWednesdayDelivery(Boolean value) { this.WednesdayDelivery = value; return this; }
        public Boolean isThursdayDelivery() { return ThursdayDelivery; }
        public C2BDeliveryInfo setThursdayDelivery(Boolean value) { this.ThursdayDelivery = value; return this; }
        public Boolean isFridayDelivery() { return FridayDelivery; }
        public C2BDeliveryInfo setFridayDelivery(Boolean value) { this.FridayDelivery = value; return this; }
        public Boolean isSaturdayDelivery() { return SaturdayDelivery; }
        public C2BDeliveryInfo setSaturdayDelivery(Boolean value) { this.SaturdayDelivery = value; return this; }
    }

}

Java GetSchoolListRequest DTOs

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>