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 Foundation
import ServiceStack

/**
* GetSchoolListRequires active-e Customer Service.
*/
// @DataContract
public 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")
    public var districtId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case districtId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        districtId = try container.decodeIfPresent(Int.self, forKey: .districtId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if districtId != nil { try container.encode(districtId, forKey: .districtId) }
    }
}

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

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class GetSchoolListResponse : BaseResponse
{
    // @DataMember
    public var schools:[SchoolGeneric] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case schools
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        schools = try container.decodeIfPresent([SchoolGeneric].self, forKey: .schools) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if schools.count > 0 { try container.encode(schools, forKey: .schools) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class SchoolGeneric : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var schoolName:String

    // @DataMember
    public var district:String

    // @DataMember
    public var address:String

    // @DataMember
    public var city:String

    // @DataMember
    public var state:String

    // @DataMember
    public var zip:String

    // @DataMember
    public var phone:String

    // @DataMember
    public var taxAuth:String

    // @DataMember
    public var deliveryInfo:C2BDeliveryInfo

    required public init(){}
}

// @DataContract
public class C2BDeliveryInfo : Codable
{
    // @DataMember
    public var firstDelivery:Date

    // @DataMember
    public var deliveryTime:Date

    // @DataMember
    public var deliveryThreshold:Int

    // @DataMember
    public var sundayDelivery:Bool

    // @DataMember
    public var mondayDelivery:Bool

    // @DataMember
    public var tuesdayDelivery:Bool

    // @DataMember
    public var wednesdayDelivery:Bool

    // @DataMember
    public var thursdayDelivery:Bool

    // @DataMember
    public var fridayDelivery:Bool

    // @DataMember
    public var saturdayDelivery:Bool

    required public init(){}
}

Swift GetSchoolListRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}