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.*


/**
* GetSchoolListRequires active-e Customer Service.
*/
@DataContract
open class GetSchoolListRequest : 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")
    var DistrictId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetSchoolListResponse : BaseResponse()
{
    @DataMember
    var Schools:ArrayList<SchoolGeneric> = ArrayList<SchoolGeneric>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class SchoolGeneric
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var SchoolName:String? = null

    @DataMember
    var District:String? = null

    @DataMember
    var Address:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Phone:String? = null

    @DataMember
    var TaxAuth:String? = null

    @DataMember
    var DeliveryInfo:C2BDeliveryInfo? = null
}

@DataContract
open class C2BDeliveryInfo
{
    @DataMember
    var FirstDelivery:Date? = null

    @DataMember
    var DeliveryTime:Date? = null

    @DataMember
    var DeliveryThreshold:Int? = null

    @DataMember
    var SundayDelivery:Boolean? = null

    @DataMember
    var MondayDelivery:Boolean? = null

    @DataMember
    var TuesdayDelivery:Boolean? = null

    @DataMember
    var WednesdayDelivery:Boolean? = null

    @DataMember
    var ThursdayDelivery:Boolean? = null

    @DataMember
    var FridayDelivery:Boolean? = null

    @DataMember
    var SaturdayDelivery:Boolean? = null
}

Kotlin GetSchoolListRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"Schools":[{"Id":0,"SchoolName":"String","District":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","TaxAuth":"String","DeliveryInfo":{"DeliveryThreshold":0,"SundayDelivery":false,"MondayDelivery":false,"TuesdayDelivery":false,"WednesdayDelivery":false,"ThursdayDelivery":false,"FridayDelivery":false,"SaturdayDelivery":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}