AIM Web Services

<back to all web services

C2BGetInstrumentInfoRequest

C2BGetInstrumentInfo
Requires active-e Contracts Service.

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


/**
* C2BGetInstrumentInfoRequires active-e Contracts Service.
*/
@DataContract
open class C2BGetInstrumentInfoRequest : BaseSecureRequest()
{
    /**
    * ID of the Teacher/Instrument record.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record.", Format="int64", Name="RsiPk", ParameterType="query")
    open var RsiPk:Long? = null

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

    /**
    * Optional Plan Code Override. If not sent, plancode from the school will be used.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Optional Plan Code Override. If not sent, plancode from the school will be used.", Name="PlanCode", ParameterType="query")
    open var PlanCode:String? = null

    /**
    * If set to false, less details will be sent. Defaults to True.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If set to false, less details will be sent. Defaults to True.", Name="GetDetails", ParameterType="query")
    open var GetDetails:Boolean? = null

    /**
    * If set to true, Out of Stock items will be included.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If set to true, Out of Stock items will be included.", Name="IncludeOutOfStockItems", ParameterType="query")
    open var IncludeOutOfStockItems:Boolean? = null

    /**
    * If set to true, each instrument will include a list of accessory options. Defaults to False.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of accessory options. Defaults to False.", Name="IncludeAccessoryOptions", ParameterType="query")
    open var IncludeAccessoryOptions:Boolean? = null

    /**
    * If set to true, each instrument will include a list of delivery options. Defaults to False.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of delivery options. Defaults to False.", Name="IncludeDeliveryOptions", ParameterType="query")
    open var IncludeDeliveryOptions:Boolean? = null

    /**
    * If set to true, each instrument will include a list of maintenance options. Defaults to False.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of maintenance options. Defaults to False.", Name="IncludeMaintenanceOptions", ParameterType="query")
    open var IncludeMaintenanceOptions:Boolean? = 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 C2BGetInstrumentInfoResponse : BaseResponse()
{
    @DataMember
    open var Instruments:ArrayList<C2BInstrumentGeneric>? = 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 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
}

Kotlin C2BGetInstrumentInfoRequest 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/C2BGetInstrumentInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RsiPk":0,"TeacherId":0,"PlanCode":"String","GetDetails":false,"IncludeOutOfStockItems":false,"IncludeAccessoryOptions":false,"IncludeDeliveryOptions":false,"IncludeMaintenanceOptions":false,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

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