| POST, GET | /api/C2BGetTeacherInfo |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* C2BGetTeacherInfoRequires active-e Contracts Service.
*/
@DataContract
public static class C2BGetTeacherInfoRequest extends 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")
public String PlanCode = 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")
public Long SchoolId = 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")
public Long TeacherId = null;
/**
* ID of the Instrument record. Optional.
*/
@DataMember
@ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")
public Long RinPk = 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")
public String RequestType = null;
public String getPlanCode() { return PlanCode; }
public C2BGetTeacherInfoRequest setPlanCode(String value) { this.PlanCode = value; return this; }
public Long getSchoolId() { return SchoolId; }
public C2BGetTeacherInfoRequest setSchoolId(Long value) { this.SchoolId = value; return this; }
public Long getTeacherId() { return TeacherId; }
public C2BGetTeacherInfoRequest setTeacherId(Long value) { this.TeacherId = value; return this; }
public Long getRinPk() { return RinPk; }
public C2BGetTeacherInfoRequest setRinPk(Long value) { this.RinPk = value; return this; }
public String getRequestType() { return RequestType; }
public C2BGetTeacherInfoRequest setRequestType(String value) { this.RequestType = value; return this; }
}
@DataContract
public static 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")
public String ApiKey = null;
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public String OAuthToken = null;
public String getApiKey() { return ApiKey; }
public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
public String getOAuthToken() { return OAuthToken; }
public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
}
@DataContract
public static class C2BGetTeacherInfoResponse extends BaseResponse
{
@DataMember
public ArrayList<C2BTeacherGeneric> Teachers = null;
@DataMember
public String PlanCode = null;
public ArrayList<C2BTeacherGeneric> getTeachers() { return Teachers; }
public C2BGetTeacherInfoResponse setTeachers(ArrayList<C2BTeacherGeneric> value) { this.Teachers = value; return this; }
public String getPlanCode() { return PlanCode; }
public C2BGetTeacherInfoResponse setPlanCode(String value) { this.PlanCode = value; return this; }
}
@DataContract
public static class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public BaseResponseResult Status = null;
public BaseResponseResult getStatus() { return Status; }
public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
}
@DataContract
public static class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public String StatusCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public String Login = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public String ErrorCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public String ErrorDisplayText = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public String ErrorMessage = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public String DomainName = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public String IpAddress = null;
public String getStatusCode() { return StatusCode; }
public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
public String getLogin() { return Login; }
public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
public String getErrorCode() { return ErrorCode; }
public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getErrorDisplayText() { return ErrorDisplayText; }
public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
public String getErrorMessage() { return ErrorMessage; }
public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
public String getDomainName() { return DomainName; }
public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
public String getIpAddress() { return IpAddress; }
public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
}
@DataContract
public static class C2BTeacherGeneric
{
@DataMember
public String TeacherName = null;
@DataMember
public String SchoolName = null;
@DataMember
public String DistrictName = null;
@DataMember
public String Topic = null;
@DataMember
public Long Id = null;
@DataMember
public C2BDeliveryInfo DeliveryInfo = null;
@DataMember
public Long AIMSchoolId = null;
public String getTeacherName() { return TeacherName; }
public C2BTeacherGeneric setTeacherName(String value) { this.TeacherName = value; return this; }
public String getSchoolName() { return SchoolName; }
public C2BTeacherGeneric setSchoolName(String value) { this.SchoolName = value; return this; }
public String getDistrictName() { return DistrictName; }
public C2BTeacherGeneric setDistrictName(String value) { this.DistrictName = value; return this; }
public String getTopic() { return Topic; }
public C2BTeacherGeneric setTopic(String value) { this.Topic = value; return this; }
public Long getId() { return Id; }
public C2BTeacherGeneric setId(Long value) { this.Id = value; return this; }
public C2BDeliveryInfo getDeliveryInfo() { return DeliveryInfo; }
public C2BTeacherGeneric setDeliveryInfo(C2BDeliveryInfo value) { this.DeliveryInfo = value; return this; }
public Long getAimSchoolId() { return AIMSchoolId; }
public C2BTeacherGeneric setAimSchoolId(Long value) { this.AIMSchoolId = value; return this; }
}
@DataContract
public static class C2BDeliveryInfo
{
@DataMember
public Date FirstDelivery = null;
@DataMember
public Date DeliveryTime = null;
@DataMember
public Integer DeliveryThreshold = null;
@DataMember
public Boolean SundayDelivery = null;
@DataMember
public Boolean MondayDelivery = null;
@DataMember
public Boolean TuesdayDelivery = null;
@DataMember
public Boolean WednesdayDelivery = null;
@DataMember
public Boolean ThursdayDelivery = null;
@DataMember
public Boolean FridayDelivery = null;
@DataMember
public Boolean SaturdayDelivery = null;
public Date getFirstDelivery() { return FirstDelivery; }
public C2BDeliveryInfo setFirstDelivery(Date value) { this.FirstDelivery = value; return this; }
public Date getDeliveryTime() { return DeliveryTime; }
public C2BDeliveryInfo setDeliveryTime(Date value) { this.DeliveryTime = value; return this; }
public Integer getDeliveryThreshold() { return DeliveryThreshold; }
public C2BDeliveryInfo setDeliveryThreshold(Integer value) { this.DeliveryThreshold = value; return this; }
public Boolean isSundayDelivery() { return SundayDelivery; }
public C2BDeliveryInfo setSundayDelivery(Boolean value) { this.SundayDelivery = value; return this; }
public Boolean isMondayDelivery() { return MondayDelivery; }
public C2BDeliveryInfo setMondayDelivery(Boolean value) { this.MondayDelivery = value; return this; }
public Boolean isTuesdayDelivery() { return TuesdayDelivery; }
public C2BDeliveryInfo setTuesdayDelivery(Boolean value) { this.TuesdayDelivery = value; return this; }
public Boolean isWednesdayDelivery() { return WednesdayDelivery; }
public C2BDeliveryInfo setWednesdayDelivery(Boolean value) { this.WednesdayDelivery = value; return this; }
public Boolean isThursdayDelivery() { return ThursdayDelivery; }
public C2BDeliveryInfo setThursdayDelivery(Boolean value) { this.ThursdayDelivery = value; return this; }
public Boolean isFridayDelivery() { return FridayDelivery; }
public C2BDeliveryInfo setFridayDelivery(Boolean value) { this.FridayDelivery = value; return this; }
public Boolean isSaturdayDelivery() { return SaturdayDelivery; }
public C2BDeliveryInfo setSaturdayDelivery(Boolean value) { this.SaturdayDelivery = value; return this; }
}
}
Java 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
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"}}