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 java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* C2BGetInstrumentDetailRequires active-e Contracts Service.
*/
@DataContract
open class C2BGetInstrumentDetailRequest : 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")
    open var RsiPk:Long? = 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")
    open var TeacherId:Long? = 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")
    open var InstrumentId:Long? = 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")
    open var RateId:Long? = 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")
    open var IncludeMobileLayout:String? = 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")
    open var DeliveryId:Long? = 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")
    open var LocationId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class C2BGetInstrumentDetailResponse : BaseResponse()
{
    @DataMember
    open var InstrumentDetails:C2BInstrumentDetailGeneric? = null

    @DataMember
    open var MobileLayout:MobileLayout? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    open var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class C2BInstrumentDetailGeneric
{
    @DataMember
    open var PlanCode:C2BPlanCodeGeneric? = null

    @DataMember
    open var Teacher:C2BTeacherGeneric? = null

    @DataMember
    open var School:C2BSchoolGeneric? = null

    @DataMember
    open var DeliveryDate:String? = null

    @DataMember
    open var SalesPerson:String? = null

    @DataMember
    open var District:C2BDistrictGeneric? = null

    @DataMember
    open var Instrument:C2BInstrumentGeneric? = null

    @DataMember
    open var Grade:C2BGradeGeneric? = null

    @DataMember
    open var AccessoryList:ArrayList<C2BAccessoryGeneric>? = null

    @DataMember
    open var DeliveryList:ArrayList<C2BAccessoryGeneric>? = null

    @DataMember
    open var MaintenanceList:ArrayList<C2BAccessoryGeneric>? = null
}

@DataContract
open class C2BPlanCodeGeneric
{
    @DataMember
    open var Code:String? = null

    @DataMember
    open var Name:String? = null

    @DataMember
    open var Months:Int? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Url:String? = null

    @DataMember
    open var FinalTopic:String? = null
}

@DataContract
open class C2BTeacherGeneric
{
    @DataMember
    open var TeacherName:String? = null

    @DataMember
    open var SchoolName:String? = null

    @DataMember
    open var DistrictName:String? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Id:Long? = null

    @DataMember
    open var DeliveryInfo:C2BDeliveryInfo? = null

    @DataMember
    open var AIMSchoolId:Long? = null
}

@DataContract
open class C2BDeliveryInfo
{
    @DataMember
    open var FirstDelivery:Date? = null

    @DataMember
    open var DeliveryTime:Date? = null

    @DataMember
    open var DeliveryThreshold:Int? = null

    @DataMember
    open var SundayDelivery:Boolean? = null

    @DataMember
    open var MondayDelivery:Boolean? = null

    @DataMember
    open var TuesdayDelivery:Boolean? = null

    @DataMember
    open var WednesdayDelivery:Boolean? = null

    @DataMember
    open var ThursdayDelivery:Boolean? = null

    @DataMember
    open var FridayDelivery:Boolean? = null

    @DataMember
    open var SaturdayDelivery:Boolean? = null
}

@DataContract
open class C2BSchoolGeneric
{
    @DataMember
    open var SchoolName:String? = null

    @DataMember
    open var DistrictName:String? = null

    @DataMember
    open var TeacherCount:Int? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Id:Long? = null

    @DataMember
    open var DeliveryInfo:C2BDeliveryInfo? = null

    @DataMember
    open var AIMSchoolId:Long? = null
}

@DataContract
open class C2BDistrictGeneric
{
    @DataMember
    open var DistrictName:String? = null

    @DataMember
    open var SchoolCount:Int? = null

    @DataMember
    open var TeacherCount:Int? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Id:Long? = null

    @DataMember
    open var State:String? = null
}

@DataContract
open class C2BInstrumentGeneric
{
    @DataMember
    open var InstrumentName:String? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Image:String? = null

    @DataMember
    open var Level:Int? = null

    @DataMember
    open var RentPrice:BigDecimal? = null

    @DataMember
    open var CashPrice:BigDecimal? = null

    @DataMember
    open var Token:String? = null

    @DataMember
    open var InstrumentId:Long? = null

    @DataMember
    open var InstrumentTeacherId:Long? = null

    @DataMember
    open var GradeList:ArrayList<C2BGradeGeneric>? = null

    @DataMember
    open var HasGrades:Boolean? = null

    @DataMember
    open var DisplayOrder:Int? = null

    @DataMember
    open var AccessoryList:ArrayList<C2BAccessoryGeneric>? = null

    @DataMember
    open var DeliveryList:ArrayList<C2BAccessoryGeneric>? = null

    @DataMember
    open var MaintenanceList:ArrayList<C2BAccessoryGeneric>? = null
}

@DataContract
open class C2BGradeGeneric
{
    @DataMember
    open var Level:Int? = null

    @DataMember
    open var Grade:String? = null

    @DataMember
    open var DownPay:BigDecimal? = null

    @DataMember
    open var DownMaint:BigDecimal? = null

    @DataMember
    open var MoPay:BigDecimal? = null

    @DataMember
    open var MoMaint:BigDecimal? = null

    @DataMember
    open var Id:Long? = null

    @DataMember
    open var OutOfStock:Boolean? = null

    @DataMember
    open var RentPrice:BigDecimal? = null

    @DataMember
    open var CashPrice:BigDecimal? = null

    @DataMember
    open var DownPayTax:BigDecimal? = null

    @DataMember
    open var DownMaintTax:BigDecimal? = null

    @DataMember
    open var MoPayTax:BigDecimal? = null

    @DataMember
    open var MoMaintTax:BigDecimal? = null

    @DataMember
    open var RentPricePlusTax:BigDecimal? = null

    @DataMember
    open var RentPricePlusTaxLessDownpay:BigDecimal? = null

    @DataMember
    open var Months:Int? = null
}

@DataContract
open class C2BAccessoryGeneric
{
    @DataMember
    open var AccessoryDesc:String? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var Required:Boolean? = null

    @DataMember
    open var Default:Boolean? = null

    @DataMember
    open var RequiresLocation:Boolean? = null

    @DataMember
    open var Type:String? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var Id:Long? = null

    @DataMember
    open var DisplayOrder:Int? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var TaxAmount:BigDecimal? = null

    @DataMember
    open var CatNum:Int? = null
}

@DataContract
open class MobileLayout
{
    @DataMember
    open var title:String? = null

    @DataMember
    open var returnurl:String? = null

    @DataMember
    open var sections:ArrayList<Section>? = null
}

@DataContract
open class Section
{
    @DataMember
    open var header:String? = null

    @DataMember
    open var id:String? = null

    @DataMember
    open var margin:String? = null

    @DataMember
    open var elements:ArrayList<Element>? = null
}

@DataContract
open class Element
{
    @DataMember
    @SerializedName("type") open var Type:String? = null

    @DataMember
    open var label:String? = null

    @DataMember
    open var id:String? = null

    @DataMember
    open var fontsize:String? = null

    @DataMember
    open var margin:String? = null

    @DataMember
    open var backgroundcolor:String? = null

    @DataMember
    open var textcolor:String? = null

    @DataMember
    open var height:String? = null

    @DataMember
    open var width:String? = null

    @DataMember
    open var value:String? = null

    @DataMember
    open var addvalue:Boolean? = null

    @DataMember
    open var values:ArrayList<String>? = null

    @DataMember
    open var textalign:String? = null

    @DataMember
    open var required:Boolean? = null

    @DataMember
    open var placeholder:String? = null

    @DataMember
    open var fontbold:Boolean? = null

    @DataMember
    open var selected:Boolean? = null

    @DataMember
    open var disabled:Boolean? = null

    @DataMember
    open var totalamount:Boolean? = null

    @DataMember
    open var elements:ArrayList<Element>? = null

    @DataMember
    open var map:ArrayList<LicenseMap>? = null
}

@DataContract
open class LicenseMap
{
    @DataMember
    open var name:String? = null

    @DataMember
    open var value:String? = null
}

Kotlin 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","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"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"}}