AIM Web Services

<back to all web services

C2BGetSchoolInfoRequest

C2BGetSchoolInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetSchoolInfo
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 C2BSchoolGeneric() = 
        [<DataMember>]
        member val SchoolName:String = null with get,set

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

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

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

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

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

        [<DataMember>]
        member val AIMSchoolId:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetSchoolInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Schools:ResizeArray<C2BSchoolGeneric> = new ResizeArray<C2BSchoolGeneric>() 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

    ///<summary>
    ///C2BGetSchoolInfoRequires active-e Contracts Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetSchoolInfoRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///If sent, only schools associated with the sent plan code will be returned.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="If sent, only schools associated with the sent plan code will be returned.", Name="PlanCode", ParameterType="query")>]
        member val PlanCode:String = null with get,set

        ///<summary>
        ///If sent, only schools associated with the sent district will be returned.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, only schools associated with the sent district will be returned.", Format="int64", Name="DistrictId", ParameterType="query")>]
        member val DistrictId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///ID of the Instrument record. Optional.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")>]
        member val RinPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///Optional Request Type. Valid values are Contract and Shipping.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Optional Request Type. Valid values are Contract and Shipping.", Name="RequestType", ParameterType="query")>]
        member val RequestType:String = null with get,set

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

POST /api/C2BGetSchoolInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PlanCode":"String","DistrictId":0,"RinPk":0,"RequestType":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Schools":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}