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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class C2BAccessoryGeneric
    {
        [DataMember]
        public virtual string AccessoryDesc { get; set; }

        [DataMember]
        public virtual decimal Price { get; set; }

        [DataMember]
        public virtual bool Required { get; set; }

        [DataMember]
        public virtual bool Default { get; set; }

        [DataMember]
        public virtual bool RequiresLocation { get; set; }

        [DataMember]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual int DisplayOrder { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual decimal? TaxAmount { get; set; }

        [DataMember]
        public virtual int? CatNum { get; set; }
    }

    [DataContract]
    public partial class C2BGradeGeneric
    {
        [DataMember]
        public virtual int Level { get; set; }

        [DataMember]
        public virtual string Grade { get; set; }

        [DataMember]
        public virtual decimal DownPay { get; set; }

        [DataMember]
        public virtual decimal DownMaint { get; set; }

        [DataMember]
        public virtual decimal MoPay { get; set; }

        [DataMember]
        public virtual decimal MoMaint { get; set; }

        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual bool OutOfStock { get; set; }

        [DataMember]
        public virtual decimal RentPrice { get; set; }

        [DataMember]
        public virtual decimal CashPrice { get; set; }

        [DataMember]
        public virtual decimal? DownPayTax { get; set; }

        [DataMember]
        public virtual decimal? DownMaintTax { get; set; }

        [DataMember]
        public virtual decimal? MoPayTax { get; set; }

        [DataMember]
        public virtual decimal? MoMaintTax { get; set; }

        [DataMember]
        public virtual decimal RentPricePlusTax { get; set; }

        [DataMember]
        public virtual decimal RentPricePlusTaxLessDownpay { get; set; }

        [DataMember]
        public virtual int Months { get; set; }
    }

    [DataContract]
    public partial class C2BInstrumentGeneric
    {
        public C2BInstrumentGeneric()
        {
            GradeList = new List<C2BGradeGeneric>{};
            AccessoryList = new List<C2BAccessoryGeneric>{};
            DeliveryList = new List<C2BAccessoryGeneric>{};
            MaintenanceList = new List<C2BAccessoryGeneric>{};
        }

        [DataMember]
        public virtual string InstrumentName { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual string Image { get; set; }

        [DataMember]
        public virtual int Level { get; set; }

        [DataMember]
        public virtual decimal? RentPrice { get; set; }

        [DataMember]
        public virtual decimal? CashPrice { get; set; }

        [DataMember]
        public virtual string Token { get; set; }

        [DataMember]
        public virtual long InstrumentId { get; set; }

        [DataMember]
        public virtual long InstrumentTeacherId { get; set; }

        [DataMember]
        public virtual List<C2BGradeGeneric> GradeList { get; set; }

        [DataMember]
        public virtual bool HasGrades { get; set; }

        [DataMember]
        public virtual int DisplayOrder { get; set; }

        [DataMember]
        public virtual List<C2BAccessoryGeneric> AccessoryList { get; set; }

        [DataMember]
        public virtual List<C2BAccessoryGeneric> DeliveryList { get; set; }

        [DataMember]
        public virtual List<C2BAccessoryGeneric> MaintenanceList { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///C2BGetInstrumentInfoRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BGetInstrumentInfoRequest
        : 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")]
        public virtual long? RsiPk { 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")]
        public virtual long? TeacherId { 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")]
        public virtual string PlanCode { 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")]
        public virtual bool? GetDetails { 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")]
        public virtual bool? IncludeOutOfStockItems { 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")]
        public virtual bool? IncludeAccessoryOptions { 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")]
        public virtual bool? IncludeDeliveryOptions { 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")]
        public virtual bool? IncludeMaintenanceOptions { get; set; }
    }

    [DataContract]
    public partial class C2BGetInstrumentInfoResponse
        : BaseResponse
    {
        public C2BGetInstrumentInfoResponse()
        {
            Instruments = new List<C2BInstrumentGeneric>{};
        }

        [DataMember]
        public virtual List<C2BInstrumentGeneric> Instruments { get; set; }
    }

}

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