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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* C2BGetSchoolInfoRequires active-e Contracts Service.
*/
@DataContract
open class C2BGetSchoolInfoRequest : BaseRequest()
{
    /**
    * If sent, only schools associated with the sent plan code will be returned.
    */
    @DataMember
    @ApiMember(DataType="string", Description="If sent, only schools associated with the sent plan code will be returned.", Name="PlanCode", ParameterType="query")
    var PlanCode:String? = null

    /**
    * If sent, only schools associated with the sent district will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only schools associated with the sent district will be returned.", Format="int64", Name="DistrictId", ParameterType="query")
    var DistrictId:Long? = null

    /**
    * ID of the Instrument record. Optional.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")
    var RinPk:Long? = null

    /**
    * Optional Request Type. Valid values are Contract and Shipping.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Optional Request Type. Valid values are Contract and Shipping.", Name="RequestType", ParameterType="query")
    var RequestType: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 C2BGetSchoolInfoResponse : BaseResponse()
{
    @DataMember
    var Schools:ArrayList<C2BSchoolGeneric> = ArrayList<C2BSchoolGeneric>()
}

@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 C2BSchoolGeneric
{
    @DataMember
    var SchoolName:String? = null

    @DataMember
    var DistrictName:String? = null

    @DataMember
    var TeacherCount:Int? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Id:Long? = null

    @DataMember
    var DeliveryInfo:C2BDeliveryInfo? = null

    @DataMember
    var AIMSchoolId:Long? = 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 C2BGetSchoolInfoRequest 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.

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

<C2BGetSchoolInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <DistrictId>0</DistrictId>
  <PlanCode>String</PlanCode>
  <RequestType>String</RequestType>
  <RinPk>0</RinPk>
</C2BGetSchoolInfoRequest>

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

<C2BGetSchoolInfoResponse 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:C2BSchoolGeneric i:nil="true" />
  </Schools>
</C2BGetSchoolInfoResponse>