AIM Web Services

<back to all web services

C2BGetTeacherInfoRequest

C2BGetTeacherInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetTeacherInfo
import java.math.*
import java.util.*
import net.servicestack.client.*


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

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

    /**
    * If sent, only info for the sent teacher will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only info for the sent teacher will be returned.", Format="int64", Name="DistrictId", ParameterType="query")
    var TeacherId: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 C2BGetTeacherInfoResponse : BaseResponse()
{
    @DataMember
    var Teachers:ArrayList<C2BTeacherGeneric> = ArrayList<C2BTeacherGeneric>()

    @DataMember
    var PlanCode:String? = null
}

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

    @DataMember
    var SchoolName:String? = null

    @DataMember
    var DistrictName:String? = 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 C2BGetTeacherInfoRequest 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/C2BGetTeacherInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

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

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