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

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 C2BDeliveryInfo
    {
        [DataMember]
        public virtual DateTime FirstDelivery { get; set; }

        [DataMember]
        public virtual DateTime DeliveryTime { get; set; }

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

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

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

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

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

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

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

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

    [DataContract]
    public partial class C2BDistrictGeneric
    {
        [DataMember]
        public virtual string? DistrictName { get; set; }

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

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

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

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

        [DataMember]
        public virtual string? State { 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 C2BInstrumentDetailGeneric
    {
        [DataMember]
        public virtual C2BPlanCodeGeneric? PlanCode { get; set; }

        [DataMember]
        public virtual C2BTeacherGeneric? Teacher { get; set; }

        [DataMember]
        public virtual C2BSchoolGeneric? School { get; set; }

        [DataMember]
        public virtual string? DeliveryDate { get; set; }

        [DataMember]
        public virtual string? SalesPerson { get; set; }

        [DataMember]
        public virtual C2BDistrictGeneric? District { get; set; }

        [DataMember]
        public virtual C2BInstrumentGeneric? Instrument { get; set; }

        [DataMember]
        public virtual C2BGradeGeneric? Grade { 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; }
    }

    [DataContract]
    public partial class C2BInstrumentGeneric
    {
        [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; }
    }

    [DataContract]
    public partial class C2BPlanCodeGeneric
    {
        [DataMember]
        public virtual string? Code { get; set; }

        [DataMember]
        public virtual string? Name { get; set; }

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

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

        [DataMember]
        public virtual string? Url { get; set; }

        [DataMember]
        public virtual string? FinalTopic { get; set; }
    }

    [DataContract]
    public partial class C2BSchoolGeneric
    {
        [DataMember]
        public virtual string? SchoolName { get; set; }

        [DataMember]
        public virtual string? DistrictName { get; set; }

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

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

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

        [DataMember]
        public virtual C2BDeliveryInfo? DeliveryInfo { get; set; }

        [DataMember]
        public virtual long? AIMSchoolId { get; set; }
    }

    [DataContract]
    public partial class C2BTeacherGeneric
    {
        [DataMember]
        public virtual string? TeacherName { get; set; }

        [DataMember]
        public virtual string? SchoolName { get; set; }

        [DataMember]
        public virtual string? DistrictName { get; set; }

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

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

        [DataMember]
        public virtual C2BDeliveryInfo? DeliveryInfo { get; set; }

        [DataMember]
        public virtual long? AIMSchoolId { get; set; }
    }

}

namespace AIM.BL.Core.ExternalAPIs.MobileRentals
{
    [DataContract]
    public partial class MobileLayout
    {
        [DataMember]
        public virtual string? title { get; set; }

        [DataMember]
        public virtual string? returnurl { get; set; }

        [DataMember]
        public virtual Section[]? sections { get; set; }
        [DataContract]
        public partial class Section
        {
            [DataMember]
            public virtual string? header { get; set; }

            [DataMember]
            public virtual string? id { get; set; }

            [DataMember]
            public virtual string? margin { get; set; }

            [DataMember]
            public virtual Element[]? elements { get; set; }
        }

        [DataContract]
        public partial class Element
        {
            [DataMember]
            public virtual string? type { get; set; }

            [DataMember]
            public virtual string? label { get; set; }

            [DataMember]
            public virtual string? id { get; set; }

            [DataMember]
            public virtual string? fontsize { get; set; }

            [DataMember]
            public virtual string? margin { get; set; }

            [DataMember]
            public virtual string? backgroundcolor { get; set; }

            [DataMember]
            public virtual string? textcolor { get; set; }

            [DataMember]
            public virtual string? height { get; set; }

            [DataMember]
            public virtual string? width { get; set; }

            [DataMember]
            public virtual string? value { get; set; }

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

            [DataMember]
            public virtual string[]? values { get; set; }

            [DataMember]
            public virtual string? textalign { get; set; }

            [DataMember]
            public virtual bool? required { get; set; }

            [DataMember]
            public virtual string? placeholder { get; set; }

            [DataMember]
            public virtual bool? fontbold { get; set; }

            [DataMember]
            public virtual bool? selected { get; set; }

            [DataMember]
            public virtual bool? disabled { get; set; }

            [DataMember]
            public virtual bool? totalamount { get; set; }

            [DataMember]
            public virtual IEnumerable<Element>? elements { get; set; }

            [DataMember]
            public virtual IEnumerable<LicenseMap>? map { get; set; }
        }

        [DataContract]
        public partial class LicenseMap
        {
            [DataMember]
            public virtual string? name { get; set; }

            [DataMember]
            public virtual string? value { 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; }

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

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")]
        public virtual string? DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { 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>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")]
        public virtual string? Token { get; set; }
    }

    ///<summary>
    ///C2BGetInstrumentDetailRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BGetInstrumentDetailRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.
        ///</summary>
        [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")]
        public virtual long? RsiPk { get; set; }

        ///<summary>
        ///ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")]
        public virtual long? TeacherId { get; set; }

        ///<summary>
        ///ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")]
        public virtual long? InstrumentId { get; set; }

        ///<summary>
        ///ID of the Rate to be used. This is required.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")]
        public virtual long RateId { get; set; }

        ///<summary>
        ///If 'Y', then Mobile Layout will be returned.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")]
        public virtual string? IncludeMobileLayout { get; set; }

        ///<summary>
        ///ID of the Delivery option to be used.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")]
        public virtual long DeliveryId { get; set; }

        ///<summary>
        ///ID of the Location. Used for Location required Delivery options.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")]
        public virtual long LocationId { get; set; }
    }

    [DataContract]
    public partial class C2BGetInstrumentDetailResponse
        : BaseResponse
    {
        [DataMember]
        public virtual C2BInstrumentDetailGeneric? InstrumentDetails { get; set; }

        [DataMember]
        public virtual MobileLayout? MobileLayout { get; set; }
    }

}

C# 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"}}