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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGradeGeneric() = 
        [<DataMember>]
        member val Level:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Grade:String = null with get,set

        [<DataMember>]
        member val DownPay:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val DownMaint:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MoPay:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MoMaint:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val OutOfStock:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val RentPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CashPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val DownPayTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val DownMaintTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val MoPayTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val MoMaintTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val RentPricePlusTax:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val RentPricePlusTaxLessDownpay:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Months:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BAccessoryGeneric() = 
        [<DataMember>]
        member val AccessoryDesc:String = null with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Required:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Default:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val RequiresLocation:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val DisplayOrder:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CatNum:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BInstrumentGeneric() = 
        [<DataMember>]
        member val InstrumentName:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val Image:String = null with get,set

        [<DataMember>]
        member val Level:Int32 = new Int32() with get,set

        [<DataMember>]
        member val RentPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CashPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Token:String = null with get,set

        [<DataMember>]
        member val InstrumentId:Int64 = new Int64() with get,set

        [<DataMember>]
        member val InstrumentTeacherId:Int64 = new Int64() with get,set

        [<DataMember>]
        member val GradeList:ResizeArray<C2BGradeGeneric> = new ResizeArray<C2BGradeGeneric>() with get,set

        [<DataMember>]
        member val HasGrades:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val DisplayOrder:Int32 = new Int32() with get,set

        [<DataMember>]
        member val AccessoryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set

        [<DataMember>]
        member val DeliveryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set

        [<DataMember>]
        member val MaintenanceList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetInstrumentInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Instruments:ResizeArray<C2BInstrumentGeneric> = new ResizeArray<C2BInstrumentGeneric>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///C2BGetInstrumentInfoRequires active-e Contracts Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetInstrumentInfoRequest() = 
        inherit BaseSecureRequest()
        ///<summary>
        ///ID of the Teacher/Instrument record.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record.", Format="int64", Name="RsiPk", ParameterType="query")>]
        member val RsiPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///ID of the Teacher record.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="ID of the Teacher record.", Format="int64", Name="TeacherId", ParameterType="query")>]
        member val TeacherId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///Optional Plan Code Override. If not sent, plancode from the school will be used.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Optional Plan Code Override. If not sent, plancode from the school will be used.", Name="PlanCode", ParameterType="query")>]
        member val PlanCode:String = null with get,set

        ///<summary>
        ///If set to false, less details will be sent. Defaults to True.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="boolean", Description="If set to false, less details will be sent. Defaults to True.", Name="GetDetails", ParameterType="query")>]
        member val GetDetails:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If set to true, Out of Stock items will be included.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="boolean", Description="If set to true, Out of Stock items will be included.", Name="IncludeOutOfStockItems", ParameterType="query")>]
        member val IncludeOutOfStockItems:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If set to true, each instrument will include a list of accessory options. Defaults to False.
        ///</summary>
        [<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")>]
        member val IncludeAccessoryOptions:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If set to true, each instrument will include a list of delivery options. Defaults to False.
        ///</summary>
        [<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")>]
        member val IncludeDeliveryOptions:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If set to true, each instrument will include a list of maintenance options. Defaults to False.
        ///</summary>
        [<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")>]
        member val IncludeMaintenanceOptions:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# C2BGetInstrumentInfoRequest 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/C2BGetInstrumentInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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