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.*
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")
    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")
    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")
    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")
    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")
    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")
    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")
    var LocationId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId: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 C2BGetInstrumentDetailResponse : BaseResponse()
{
    @DataMember
    var InstrumentDetails:C2BInstrumentDetailGeneric? = null

    @DataMember
    var MobileLayout:MobileLayout? = 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 C2BInstrumentDetailGeneric
{
    @DataMember
    var PlanCode:C2BPlanCodeGeneric? = null

    @DataMember
    var Teacher:C2BTeacherGeneric? = null

    @DataMember
    var School:C2BSchoolGeneric? = null

    @DataMember
    var DeliveryDate:String? = null

    @DataMember
    var SalesPerson:String? = null

    @DataMember
    var District:C2BDistrictGeneric? = null

    @DataMember
    var Instrument:C2BInstrumentGeneric? = null

    @DataMember
    var Grade:C2BGradeGeneric? = null

    @DataMember
    var AccessoryList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()

    @DataMember
    var DeliveryList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()

    @DataMember
    var MaintenanceList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()
}

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

    @DataMember
    var Name:String? = null

    @DataMember
    var Months:Int? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Url:String? = null

    @DataMember
    var FinalTopic: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
}

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

    @DataMember
    var DistrictName:String? = null

    @DataMember
    var TeacherCount:Int? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Id:Long? = null

    @DataMember
    var DeliveryInfo:C2BDeliveryInfo? = null

    @DataMember
    var AIMSchoolId:Long? = null
}

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

    @DataMember
    var SchoolCount:Int? = null

    @DataMember
    var TeacherCount:Int? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Id:Long? = null
}

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

    @DataMember
    var Sku:String? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Image:String? = null

    @DataMember
    var Level:Int? = null

    @DataMember
    var RentPrice:BigDecimal? = null

    @DataMember
    var CashPrice:BigDecimal? = null

    @DataMember
    var Token:String? = null

    @DataMember
    var InstrumentId:Long? = null

    @DataMember
    var InstrumentTeacherId:Long? = null

    @DataMember
    var GradeList:ArrayList<C2BGradeGeneric> = ArrayList<C2BGradeGeneric>()

    @DataMember
    var HasGrades:Boolean? = null

    @DataMember
    var DisplayOrder:Int? = null

    @DataMember
    var AccessoryList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()

    @DataMember
    var DeliveryList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()

    @DataMember
    var MaintenanceList:ArrayList<C2BAccessoryGeneric> = ArrayList<C2BAccessoryGeneric>()
}

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

    @DataMember
    var Grade:String? = null

    @DataMember
    var DownPay:BigDecimal? = null

    @DataMember
    var DownMaint:BigDecimal? = null

    @DataMember
    var MoPay:BigDecimal? = null

    @DataMember
    var MoMaint:BigDecimal? = null

    @DataMember
    var Id:Long? = null

    @DataMember
    var OutOfStock:Boolean? = null

    @DataMember
    var RentPrice:BigDecimal? = null

    @DataMember
    var CashPrice:BigDecimal? = null

    @DataMember
    var DownPayTax:BigDecimal? = null

    @DataMember
    var DownMaintTax:BigDecimal? = null

    @DataMember
    var MoPayTax:BigDecimal? = null

    @DataMember
    var MoMaintTax:BigDecimal? = null

    @DataMember
    var RentPricePlusTax:BigDecimal? = null

    @DataMember
    var RentPricePlusTaxLessDownpay:BigDecimal? = null

    @DataMember
    var Months:Int? = null
}

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

    @DataMember
    var Price:BigDecimal? = null

    @DataMember
    var Required:Boolean? = null

    @DataMember
    var Default:Boolean? = null

    @DataMember
    var RequiresLocation:Boolean? = null

    @DataMember
    var Type:String? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Id:Long? = null

    @DataMember
    var DisplayOrder:Int? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var TaxAmount:BigDecimal? = null

    @DataMember
    var CatNum:Int? = null
}

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

    @DataMember
    var returnurl:String? = null

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

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

    @DataMember
    var id:String? = null

    @DataMember
    var margin:String? = null

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

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

    @DataMember
    var label:String? = null

    @DataMember
    var id:String? = null

    @DataMember
    var fontsize:String? = null

    @DataMember
    var margin:String? = null

    @DataMember
    var backgroundcolor:String? = null

    @DataMember
    var textcolor:String? = null

    @DataMember
    var height:String? = null

    @DataMember
    var width:String? = null

    @DataMember
    var value:String? = null

    @DataMember
    var addvalue:Boolean? = null

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

    @DataMember
    var textalign:String? = null

    @DataMember
    var required:Boolean? = null

    @DataMember
    var placeholder:String? = null

    @DataMember
    var fontbold:Boolean? = null

    @DataMember
    var selected:Boolean? = null

    @DataMember
    var disabled:Boolean? = null

    @DataMember
    var totalamount:Boolean? = null

    @DataMember
    var elements:ArrayList<Element> = ArrayList<Element>()

    @DataMember
    var map:ArrayList<LicenseMap> = ArrayList<LicenseMap>()
}

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

    @DataMember
    var value:String? = null
}

Kotlin C2BGetInstrumentDetailRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<C2BGetInstrumentDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DeliveryId>0</DeliveryId>
  <IncludeMobileLayout>String</IncludeMobileLayout>
  <InstrumentId>0</InstrumentId>
  <LocationId>0</LocationId>
  <RateId>0</RateId>
  <RsiPk>0</RsiPk>
  <TeacherId>0</TeacherId>
</C2BGetInstrumentDetailRequest>

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

<C2BGetInstrumentDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <InstrumentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM" i:nil="true" />
  <MobileLayout xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.ExternalAPIs.MobileRentals">
    <d2p1:returnurl>String</d2p1:returnurl>
    <d2p1:sections>
      <d2p1:MobileLayout.Section>
        <d2p1:elements>
          <d2p1:MobileLayout.Element>
            <d2p1:addvalue>false</d2p1:addvalue>
            <d2p1:backgroundcolor>String</d2p1:backgroundcolor>
            <d2p1:disabled>false</d2p1:disabled>
            <d2p1:elements i:nil="true" />
            <d2p1:fontbold>false</d2p1:fontbold>
            <d2p1:fontsize>String</d2p1:fontsize>
            <d2p1:height>String</d2p1:height>
            <d2p1:id>String</d2p1:id>
            <d2p1:label>String</d2p1:label>
            <d2p1:map i:nil="true" />
            <d2p1:margin>String</d2p1:margin>
            <d2p1:placeholder>String</d2p1:placeholder>
            <d2p1:required>false</d2p1:required>
            <d2p1:selected>false</d2p1:selected>
            <d2p1:textalign>String</d2p1:textalign>
            <d2p1:textcolor>String</d2p1:textcolor>
            <d2p1:totalamount>false</d2p1:totalamount>
            <d2p1:type>String</d2p1:type>
            <d2p1:value>String</d2p1:value>
            <d2p1:values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:values>
            <d2p1:width>String</d2p1:width>
          </d2p1:MobileLayout.Element>
        </d2p1:elements>
        <d2p1:header>String</d2p1:header>
        <d2p1:id>String</d2p1:id>
        <d2p1:margin>String</d2p1:margin>
      </d2p1:MobileLayout.Section>
    </d2p1:sections>
    <d2p1:title>String</d2p1:title>
  </MobileLayout>
</C2BGetInstrumentDetailResponse>