AIM Web Services

<back to all web services

C2BGetInstrumentDetailRequest

C2BGetInstrumentDetail
Requires active-e Contracts Service.

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

public class dtos
{

    /**
    * C2BGetInstrumentDetailRequires active-e Contracts Service.
    */
    @DataContract
    public static class C2BGetInstrumentDetailRequest extends BaseSecureRequest
    {
        /**
        * ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.", Format="int64", Name="RsiPk", ParameterType="query")
        public Long RsiPk = null;

        /**
        * ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")
        public Long TeacherId = null;

        /**
        * ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")
        public Long InstrumentId = null;

        /**
        * ID of the Rate to be used. This is required.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")
        public Long RateId = null;

        /**
        * If 'Y', then Mobile Layout will be returned.
        */
        @DataMember
        @ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")
        public String IncludeMobileLayout = null;

        /**
        * ID of the Delivery option to be used.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")
        public Long DeliveryId = null;

        /**
        * ID of the Location. Used for Location required Delivery options.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
        public Long LocationId = null;
        
        public Long getRsiPk() { return RsiPk; }
        public C2BGetInstrumentDetailRequest setRsiPk(Long value) { this.RsiPk = value; return this; }
        public Long getTeacherId() { return TeacherId; }
        public C2BGetInstrumentDetailRequest setTeacherId(Long value) { this.TeacherId = value; return this; }
        public Long getInstrumentId() { return InstrumentId; }
        public C2BGetInstrumentDetailRequest setInstrumentId(Long value) { this.InstrumentId = value; return this; }
        public Long getRateId() { return RateId; }
        public C2BGetInstrumentDetailRequest setRateId(Long value) { this.RateId = value; return this; }
        public String getIncludeMobileLayout() { return IncludeMobileLayout; }
        public C2BGetInstrumentDetailRequest setIncludeMobileLayout(String value) { this.IncludeMobileLayout = value; return this; }
        public Long getDeliveryId() { return DeliveryId; }
        public C2BGetInstrumentDetailRequest setDeliveryId(Long value) { this.DeliveryId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public C2BGetInstrumentDetailRequest setLocationId(Long value) { this.LocationId = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = 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 C2BGetInstrumentDetailResponse extends BaseResponse
    {
        @DataMember
        public C2BInstrumentDetailGeneric InstrumentDetails = null;

        @DataMember
        public MobileLayout MobileLayout = null;
        
        public C2BInstrumentDetailGeneric getInstrumentDetails() { return InstrumentDetails; }
        public C2BGetInstrumentDetailResponse setInstrumentDetails(C2BInstrumentDetailGeneric value) { this.InstrumentDetails = value; return this; }
        public MobileLayout getMobileLayout() { return MobileLayout; }
        public C2BGetInstrumentDetailResponse setMobileLayout(MobileLayout value) { this.MobileLayout = 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 C2BInstrumentDetailGeneric
    {
        @DataMember
        public C2BPlanCodeGeneric PlanCode = null;

        @DataMember
        public C2BTeacherGeneric Teacher = null;

        @DataMember
        public C2BSchoolGeneric School = null;

        @DataMember
        public String DeliveryDate = null;

        @DataMember
        public String SalesPerson = null;

        @DataMember
        public C2BDistrictGeneric District = null;

        @DataMember
        public C2BInstrumentGeneric Instrument = null;

        @DataMember
        public C2BGradeGeneric Grade = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> AccessoryList = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> DeliveryList = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> MaintenanceList = null;
        
        public C2BPlanCodeGeneric getPlanCode() { return PlanCode; }
        public C2BInstrumentDetailGeneric setPlanCode(C2BPlanCodeGeneric value) { this.PlanCode = value; return this; }
        public C2BTeacherGeneric getTeacher() { return Teacher; }
        public C2BInstrumentDetailGeneric setTeacher(C2BTeacherGeneric value) { this.Teacher = value; return this; }
        public C2BSchoolGeneric getSchool() { return School; }
        public C2BInstrumentDetailGeneric setSchool(C2BSchoolGeneric value) { this.School = value; return this; }
        public String getDeliveryDate() { return DeliveryDate; }
        public C2BInstrumentDetailGeneric setDeliveryDate(String value) { this.DeliveryDate = value; return this; }
        public String getSalesPerson() { return SalesPerson; }
        public C2BInstrumentDetailGeneric setSalesPerson(String value) { this.SalesPerson = value; return this; }
        public C2BDistrictGeneric getDistrict() { return District; }
        public C2BInstrumentDetailGeneric setDistrict(C2BDistrictGeneric value) { this.District = value; return this; }
        public C2BInstrumentGeneric getInstrument() { return Instrument; }
        public C2BInstrumentDetailGeneric setInstrument(C2BInstrumentGeneric value) { this.Instrument = value; return this; }
        public C2BGradeGeneric getGrade() { return Grade; }
        public C2BInstrumentDetailGeneric setGrade(C2BGradeGeneric value) { this.Grade = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getAccessoryList() { return AccessoryList; }
        public C2BInstrumentDetailGeneric setAccessoryList(ArrayList<C2BAccessoryGeneric> value) { this.AccessoryList = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getDeliveryList() { return DeliveryList; }
        public C2BInstrumentDetailGeneric setDeliveryList(ArrayList<C2BAccessoryGeneric> value) { this.DeliveryList = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getMaintenanceList() { return MaintenanceList; }
        public C2BInstrumentDetailGeneric setMaintenanceList(ArrayList<C2BAccessoryGeneric> value) { this.MaintenanceList = value; return this; }
    }

    @DataContract
    public static class C2BPlanCodeGeneric
    {
        @DataMember
        public String Code = null;

        @DataMember
        public String Name = null;

        @DataMember
        public Integer Months = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public String Url = null;

        @DataMember
        public String FinalTopic = null;
        
        public String getCode() { return Code; }
        public C2BPlanCodeGeneric setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public C2BPlanCodeGeneric setName(String value) { this.Name = value; return this; }
        public Integer getMonths() { return Months; }
        public C2BPlanCodeGeneric setMonths(Integer value) { this.Months = value; return this; }
        public String getTopic() { return Topic; }
        public C2BPlanCodeGeneric setTopic(String value) { this.Topic = value; return this; }
        public String getUrl() { return Url; }
        public C2BPlanCodeGeneric setUrl(String value) { this.Url = value; return this; }
        public String getFinalTopic() { return FinalTopic; }
        public C2BPlanCodeGeneric setFinalTopic(String value) { this.FinalTopic = 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; }
    }

    @DataContract
    public static class C2BSchoolGeneric
    {
        @DataMember
        public String SchoolName = null;

        @DataMember
        public String DistrictName = null;

        @DataMember
        public Integer TeacherCount = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public Long Id = null;

        @DataMember
        public C2BDeliveryInfo DeliveryInfo = null;

        @DataMember
        public Long AIMSchoolId = null;
        
        public String getSchoolName() { return SchoolName; }
        public C2BSchoolGeneric setSchoolName(String value) { this.SchoolName = value; return this; }
        public String getDistrictName() { return DistrictName; }
        public C2BSchoolGeneric setDistrictName(String value) { this.DistrictName = value; return this; }
        public Integer getTeacherCount() { return TeacherCount; }
        public C2BSchoolGeneric setTeacherCount(Integer value) { this.TeacherCount = value; return this; }
        public String getTopic() { return Topic; }
        public C2BSchoolGeneric setTopic(String value) { this.Topic = value; return this; }
        public Long getId() { return Id; }
        public C2BSchoolGeneric setId(Long value) { this.Id = value; return this; }
        public C2BDeliveryInfo getDeliveryInfo() { return DeliveryInfo; }
        public C2BSchoolGeneric setDeliveryInfo(C2BDeliveryInfo value) { this.DeliveryInfo = value; return this; }
        public Long getAimSchoolId() { return AIMSchoolId; }
        public C2BSchoolGeneric setAimSchoolId(Long value) { this.AIMSchoolId = value; return this; }
    }

    @DataContract
    public static class C2BDistrictGeneric
    {
        @DataMember
        public String DistrictName = null;

        @DataMember
        public Integer SchoolCount = null;

        @DataMember
        public Integer TeacherCount = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public Long Id = null;
        
        public String getDistrictName() { return DistrictName; }
        public C2BDistrictGeneric setDistrictName(String value) { this.DistrictName = value; return this; }
        public Integer getSchoolCount() { return SchoolCount; }
        public C2BDistrictGeneric setSchoolCount(Integer value) { this.SchoolCount = value; return this; }
        public Integer getTeacherCount() { return TeacherCount; }
        public C2BDistrictGeneric setTeacherCount(Integer value) { this.TeacherCount = value; return this; }
        public String getTopic() { return Topic; }
        public C2BDistrictGeneric setTopic(String value) { this.Topic = value; return this; }
        public Long getId() { return Id; }
        public C2BDistrictGeneric setId(Long value) { this.Id = value; return this; }
    }

    @DataContract
    public static class C2BInstrumentGeneric
    {
        @DataMember
        public String InstrumentName = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public String Image = null;

        @DataMember
        public Integer Level = null;

        @DataMember
        public BigDecimal RentPrice = null;

        @DataMember
        public BigDecimal CashPrice = null;

        @DataMember
        public String Token = null;

        @DataMember
        public Long InstrumentId = null;

        @DataMember
        public Long InstrumentTeacherId = null;

        @DataMember
        public ArrayList<C2BGradeGeneric> GradeList = null;

        @DataMember
        public Boolean HasGrades = null;

        @DataMember
        public Integer DisplayOrder = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> AccessoryList = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> DeliveryList = null;

        @DataMember
        public ArrayList<C2BAccessoryGeneric> MaintenanceList = null;
        
        public String getInstrumentName() { return InstrumentName; }
        public C2BInstrumentGeneric setInstrumentName(String value) { this.InstrumentName = value; return this; }
        public String getSku() { return Sku; }
        public C2BInstrumentGeneric setSku(String value) { this.Sku = value; return this; }
        public String getTopic() { return Topic; }
        public C2BInstrumentGeneric setTopic(String value) { this.Topic = value; return this; }
        public String getImage() { return Image; }
        public C2BInstrumentGeneric setImage(String value) { this.Image = value; return this; }
        public Integer getLevel() { return Level; }
        public C2BInstrumentGeneric setLevel(Integer value) { this.Level = value; return this; }
        public BigDecimal getRentPrice() { return RentPrice; }
        public C2BInstrumentGeneric setRentPrice(BigDecimal value) { this.RentPrice = value; return this; }
        public BigDecimal getCashPrice() { return CashPrice; }
        public C2BInstrumentGeneric setCashPrice(BigDecimal value) { this.CashPrice = value; return this; }
        public String getToken() { return Token; }
        public C2BInstrumentGeneric setToken(String value) { this.Token = value; return this; }
        public Long getInstrumentId() { return InstrumentId; }
        public C2BInstrumentGeneric setInstrumentId(Long value) { this.InstrumentId = value; return this; }
        public Long getInstrumentTeacherId() { return InstrumentTeacherId; }
        public C2BInstrumentGeneric setInstrumentTeacherId(Long value) { this.InstrumentTeacherId = value; return this; }
        public ArrayList<C2BGradeGeneric> getGradeList() { return GradeList; }
        public C2BInstrumentGeneric setGradeList(ArrayList<C2BGradeGeneric> value) { this.GradeList = value; return this; }
        public Boolean isHasGrades() { return HasGrades; }
        public C2BInstrumentGeneric setHasGrades(Boolean value) { this.HasGrades = value; return this; }
        public Integer getDisplayOrder() { return DisplayOrder; }
        public C2BInstrumentGeneric setDisplayOrder(Integer value) { this.DisplayOrder = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getAccessoryList() { return AccessoryList; }
        public C2BInstrumentGeneric setAccessoryList(ArrayList<C2BAccessoryGeneric> value) { this.AccessoryList = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getDeliveryList() { return DeliveryList; }
        public C2BInstrumentGeneric setDeliveryList(ArrayList<C2BAccessoryGeneric> value) { this.DeliveryList = value; return this; }
        public ArrayList<C2BAccessoryGeneric> getMaintenanceList() { return MaintenanceList; }
        public C2BInstrumentGeneric setMaintenanceList(ArrayList<C2BAccessoryGeneric> value) { this.MaintenanceList = value; return this; }
    }

    @DataContract
    public static class C2BGradeGeneric
    {
        @DataMember
        public Integer Level = null;

        @DataMember
        public String Grade = null;

        @DataMember
        public BigDecimal DownPay = null;

        @DataMember
        public BigDecimal DownMaint = null;

        @DataMember
        public BigDecimal MoPay = null;

        @DataMember
        public BigDecimal MoMaint = null;

        @DataMember
        public Long Id = null;

        @DataMember
        public Boolean OutOfStock = null;

        @DataMember
        public BigDecimal RentPrice = null;

        @DataMember
        public BigDecimal CashPrice = null;

        @DataMember
        public BigDecimal DownPayTax = null;

        @DataMember
        public BigDecimal DownMaintTax = null;

        @DataMember
        public BigDecimal MoPayTax = null;

        @DataMember
        public BigDecimal MoMaintTax = null;

        @DataMember
        public BigDecimal RentPricePlusTax = null;

        @DataMember
        public BigDecimal RentPricePlusTaxLessDownpay = null;

        @DataMember
        public Integer Months = null;
        
        public Integer getLevel() { return Level; }
        public C2BGradeGeneric setLevel(Integer value) { this.Level = value; return this; }
        public String getGrade() { return Grade; }
        public C2BGradeGeneric setGrade(String value) { this.Grade = value; return this; }
        public BigDecimal getDownPay() { return DownPay; }
        public C2BGradeGeneric setDownPay(BigDecimal value) { this.DownPay = value; return this; }
        public BigDecimal getDownMaint() { return DownMaint; }
        public C2BGradeGeneric setDownMaint(BigDecimal value) { this.DownMaint = value; return this; }
        public BigDecimal getMoPay() { return MoPay; }
        public C2BGradeGeneric setMoPay(BigDecimal value) { this.MoPay = value; return this; }
        public BigDecimal getMoMaint() { return MoMaint; }
        public C2BGradeGeneric setMoMaint(BigDecimal value) { this.MoMaint = value; return this; }
        public Long getId() { return Id; }
        public C2BGradeGeneric setId(Long value) { this.Id = value; return this; }
        public Boolean isOutOfStock() { return OutOfStock; }
        public C2BGradeGeneric setOutOfStock(Boolean value) { this.OutOfStock = value; return this; }
        public BigDecimal getRentPrice() { return RentPrice; }
        public C2BGradeGeneric setRentPrice(BigDecimal value) { this.RentPrice = value; return this; }
        public BigDecimal getCashPrice() { return CashPrice; }
        public C2BGradeGeneric setCashPrice(BigDecimal value) { this.CashPrice = value; return this; }
        public BigDecimal getDownPayTax() { return DownPayTax; }
        public C2BGradeGeneric setDownPayTax(BigDecimal value) { this.DownPayTax = value; return this; }
        public BigDecimal getDownMaintTax() { return DownMaintTax; }
        public C2BGradeGeneric setDownMaintTax(BigDecimal value) { this.DownMaintTax = value; return this; }
        public BigDecimal getMoPayTax() { return MoPayTax; }
        public C2BGradeGeneric setMoPayTax(BigDecimal value) { this.MoPayTax = value; return this; }
        public BigDecimal getMoMaintTax() { return MoMaintTax; }
        public C2BGradeGeneric setMoMaintTax(BigDecimal value) { this.MoMaintTax = value; return this; }
        public BigDecimal getRentPricePlusTax() { return RentPricePlusTax; }
        public C2BGradeGeneric setRentPricePlusTax(BigDecimal value) { this.RentPricePlusTax = value; return this; }
        public BigDecimal getRentPricePlusTaxLessDownpay() { return RentPricePlusTaxLessDownpay; }
        public C2BGradeGeneric setRentPricePlusTaxLessDownpay(BigDecimal value) { this.RentPricePlusTaxLessDownpay = value; return this; }
        public Integer getMonths() { return Months; }
        public C2BGradeGeneric setMonths(Integer value) { this.Months = value; return this; }
    }

    @DataContract
    public static class C2BAccessoryGeneric
    {
        @DataMember
        public String AccessoryDesc = null;

        @DataMember
        public BigDecimal Price = null;

        @DataMember
        public Boolean Required = null;

        @DataMember
        public Boolean Default = null;

        @DataMember
        public Boolean RequiresLocation = null;

        @DataMember
        public String Type = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public Long Id = null;

        @DataMember
        public Integer DisplayOrder = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public BigDecimal TaxAmount = null;

        @DataMember
        public Integer CatNum = null;
        
        public String getAccessoryDesc() { return AccessoryDesc; }
        public C2BAccessoryGeneric setAccessoryDesc(String value) { this.AccessoryDesc = value; return this; }
        public BigDecimal getPrice() { return Price; }
        public C2BAccessoryGeneric setPrice(BigDecimal value) { this.Price = value; return this; }
        public Boolean isRequired() { return Required; }
        public C2BAccessoryGeneric setRequired(Boolean value) { this.Required = value; return this; }
        public Boolean isDefault() { return Default; }
        public C2BAccessoryGeneric setDefault(Boolean value) { this.Default = value; return this; }
        public Boolean isRequiresLocation() { return RequiresLocation; }
        public C2BAccessoryGeneric setRequiresLocation(Boolean value) { this.RequiresLocation = value; return this; }
        public String getType() { return Type; }
        public C2BAccessoryGeneric setType(String value) { this.Type = value; return this; }
        public String getTopic() { return Topic; }
        public C2BAccessoryGeneric setTopic(String value) { this.Topic = value; return this; }
        public Long getId() { return Id; }
        public C2BAccessoryGeneric setId(Long value) { this.Id = value; return this; }
        public Integer getDisplayOrder() { return DisplayOrder; }
        public C2BAccessoryGeneric setDisplayOrder(Integer value) { this.DisplayOrder = value; return this; }
        public String getSku() { return Sku; }
        public C2BAccessoryGeneric setSku(String value) { this.Sku = value; return this; }
        public BigDecimal getTaxAmount() { return TaxAmount; }
        public C2BAccessoryGeneric setTaxAmount(BigDecimal value) { this.TaxAmount = value; return this; }
        public Integer getCatNum() { return CatNum; }
        public C2BAccessoryGeneric setCatNum(Integer value) { this.CatNum = value; return this; }
    }

    @DataContract
    public static class MobileLayout
    {
        @DataMember
        public String title = null;

        @DataMember
        public String returnurl = null;

        @DataMember
        public ArrayList<Section> sections = null;
        
        public String getTitle() { return title; }
        public MobileLayout setTitle(String value) { this.title = value; return this; }
        public String getReturnurl() { return returnurl; }
        public MobileLayout setReturnurl(String value) { this.returnurl = value; return this; }
        public ArrayList<Section> getSections() { return sections; }
        public MobileLayout setSections(ArrayList<Section> value) { this.sections = value; return this; }
    }

    @DataContract
    public static class Section
    {
        @DataMember
        public String header = null;

        @DataMember
        public String id = null;

        @DataMember
        public String margin = null;

        @DataMember
        public ArrayList<Element> elements = null;
        
        public String getHeader() { return header; }
        public Section setHeader(String value) { this.header = value; return this; }
        public String getId() { return id; }
        public Section setId(String value) { this.id = value; return this; }
        public String getMargin() { return margin; }
        public Section setMargin(String value) { this.margin = value; return this; }
        public ArrayList<Element> getElements() { return elements; }
        public Section setElements(ArrayList<Element> value) { this.elements = value; return this; }
    }

    @DataContract
    public static class Element
    {
        @DataMember
        public String type = null;

        @DataMember
        public String label = null;

        @DataMember
        public String id = null;

        @DataMember
        public String fontsize = null;

        @DataMember
        public String margin = null;

        @DataMember
        public String backgroundcolor = null;

        @DataMember
        public String textcolor = null;

        @DataMember
        public String height = null;

        @DataMember
        public String width = null;

        @DataMember
        public String value = null;

        @DataMember
        public Boolean addvalue = null;

        @DataMember
        public ArrayList<String> values = null;

        @DataMember
        public String textalign = null;

        @DataMember
        public Boolean required = null;

        @DataMember
        public String placeholder = null;

        @DataMember
        public Boolean fontbold = null;

        @DataMember
        public Boolean selected = null;

        @DataMember
        public Boolean disabled = null;

        @DataMember
        public Boolean totalamount = null;

        @DataMember
        public ArrayList<Element> elements = null;

        @DataMember
        public ArrayList<LicenseMap> map = null;
        
        public String getType() { return type; }
        public Element setType(String value) { this.type = value; return this; }
        public String getLabel() { return label; }
        public Element setLabel(String value) { this.label = value; return this; }
        public String getId() { return id; }
        public Element setId(String value) { this.id = value; return this; }
        public String getFontsize() { return fontsize; }
        public Element setFontsize(String value) { this.fontsize = value; return this; }
        public String getMargin() { return margin; }
        public Element setMargin(String value) { this.margin = value; return this; }
        public String getBackgroundcolor() { return backgroundcolor; }
        public Element setBackgroundcolor(String value) { this.backgroundcolor = value; return this; }
        public String getTextcolor() { return textcolor; }
        public Element setTextcolor(String value) { this.textcolor = value; return this; }
        public String getHeight() { return height; }
        public Element setHeight(String value) { this.height = value; return this; }
        public String getWidth() { return width; }
        public Element setWidth(String value) { this.width = value; return this; }
        public String getValue() { return value; }
        public Element setValue(String value) { this.value = value; return this; }
        public Boolean isAddvalue() { return addvalue; }
        public Element setAddvalue(Boolean value) { this.addvalue = value; return this; }
        public ArrayList<String> getValues() { return values; }
        public Element setValues(ArrayList<String> value) { this.values = value; return this; }
        public String getTextalign() { return textalign; }
        public Element setTextalign(String value) { this.textalign = value; return this; }
        public Boolean isRequired() { return required; }
        public Element setRequired(Boolean value) { this.required = value; return this; }
        public String getPlaceholder() { return placeholder; }
        public Element setPlaceholder(String value) { this.placeholder = value; return this; }
        public Boolean isFontbold() { return fontbold; }
        public Element setFontbold(Boolean value) { this.fontbold = value; return this; }
        public Boolean isSelected() { return selected; }
        public Element setSelected(Boolean value) { this.selected = value; return this; }
        public Boolean isDisabled() { return disabled; }
        public Element setDisabled(Boolean value) { this.disabled = value; return this; }
        public Boolean isTotalamount() { return totalamount; }
        public Element setTotalamount(Boolean value) { this.totalamount = value; return this; }
        public ArrayList<Element> getElements() { return elements; }
        public Element setElements(ArrayList<Element> value) { this.elements = value; return this; }
        public ArrayList<LicenseMap> getMap() { return map; }
        public Element setMap(ArrayList<LicenseMap> value) { this.map = value; return this; }
    }

    @DataContract
    public static class LicenseMap
    {
        @DataMember
        public String name = null;

        @DataMember
        public String value = null;
        
        public String getName() { return name; }
        public LicenseMap setName(String value) { this.name = value; return this; }
        public String getValue() { return value; }
        public LicenseMap setValue(String value) { this.value = value; return this; }
    }

}

Java C2BGetInstrumentDetailRequest 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.

POST /api/C2BGetInstrumentDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RsiPk":0,"TeacherId":0,"InstrumentId":0,"RateId":0,"IncludeMobileLayout":"String","DeliveryId":0,"LocationId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"MobileLayout":{"title":"String","returnurl":"String","sections":[{"header":"String","id":"String","margin":"String","elements":[{"type":"String","label":"String","id":"String","fontsize":"String","margin":"String","backgroundcolor":"String","textcolor":"String","height":"String","width":"String","value":"String","addvalue":false,"values":["String"],"textalign":"String","required":false,"placeholder":"String","fontbold":false,"selected":false,"disabled":false,"totalamount":false}]}]},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}