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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class C2BDeliveryInfo
    {
        [DataMember]
        public virtual DateTime FirstDelivery { get; set; }

        [DataMember]
        public virtual DateTime DeliveryTime { get; set; }

        [DataMember]
        public virtual int DeliveryThreshold { get; set; }

        [DataMember]
        public virtual bool SundayDelivery { get; set; }

        [DataMember]
        public virtual bool MondayDelivery { get; set; }

        [DataMember]
        public virtual bool TuesdayDelivery { get; set; }

        [DataMember]
        public virtual bool WednesdayDelivery { get; set; }

        [DataMember]
        public virtual bool ThursdayDelivery { get; set; }

        [DataMember]
        public virtual bool FridayDelivery { get; set; }

        [DataMember]
        public virtual bool SaturdayDelivery { get; set; }
    }

    [DataContract]
    public partial class SchoolGeneric
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string SchoolName { get; set; }

        [DataMember]
        public virtual string District { get; set; }

        [DataMember]
        public virtual string Address { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string State { get; set; }

        [DataMember]
        public virtual string Zip { get; set; }

        [DataMember]
        public virtual string Phone { get; set; }

        [DataMember]
        public virtual string TaxAuth { get; set; }

        [DataMember]
        public virtual C2BDeliveryInfo DeliveryInfo { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")]
        public virtual string OAuthToken { get; set; }

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }
    }

    ///<summary>
    ///GetSchoolListRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class GetSchoolListRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.
        ///</summary>
        [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 virtual long? DistrictId { get; set; }
    }

    [DataContract]
    public partial class GetSchoolListResponse
        : BaseResponse
    {
        public GetSchoolListResponse()
        {
            Schools = new List<SchoolGeneric>{};
        }

        [DataMember]
        public virtual List<SchoolGeneric> Schools { get; set; }
    }

}

C# 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>