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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BDeliveryInfo() = 
        [<DataMember>]
        member val FirstDelivery:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DeliveryTime:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DeliveryThreshold:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SundayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val MondayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val TuesdayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val WednesdayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ThursdayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val FridayDelivery:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val SaturdayDelivery:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SchoolGeneric() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val SchoolName:String = null with get,set

        [<DataMember>]
        member val District:String = null with get,set

        [<DataMember>]
        member val Address:String = null with get,set

        [<DataMember>]
        member val City:String = null with get,set

        [<DataMember>]
        member val State:String = null with get,set

        [<DataMember>]
        member val Zip:String = null with get,set

        [<DataMember>]
        member val Phone:String = null with get,set

        [<DataMember>]
        member val TaxAuth:String = null with get,set

        [<DataMember>]
        member val DeliveryInfo:C2BDeliveryInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetSchoolListResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Schools:ResizeArray<SchoolGeneric> = new ResizeArray<SchoolGeneric>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///GetSchoolListRequires active-e Customer Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetSchoolListRequest() = 
        inherit 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")>]
        member val DistrictId:Nullable<Int64> = new Nullable<Int64>() with get,set

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