AIM Web Services

<back to all web services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BGetUnfinishedContracts
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;

namespace AIM
{
    [DataContract]
    public partial class LocationInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

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

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

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

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

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

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

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

        [DataMember]
        public virtual int? CashSaleAcct { 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>
    ///C2BGetUnfinishedContractsRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BGetUnfinishedContractsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual string? Type { get; set; }

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

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

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

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

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

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

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

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

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

    [DataContract]
    public partial class C2BGetUnfinishedContractsResponse
        : BaseResponse
    {
        [DataMember]
        public virtual List<UnfinishedContract>? UnfinishedContracts { get; set; }

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

        [DataMember]
        public virtual string? BaseUrl { get; set; }
        [DataContract]
        public partial class UnfinishedContract
        {
            [DataMember]
            public virtual string? CustomerName { get; set; }

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

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

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

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

            [DataMember]
            public virtual LocationInfo? Location { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            [DataMember]
            public virtual DateTime? FirstDue { get; set; }

            [DataMember]
            public virtual List<C2BAccessory>? Accessories { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            [DataMember]
            public virtual bool ContractCreated { get; set; }
            [DataContract]
            public partial class C2BAccessory
            {
                [DataMember]
                public virtual long Id { get; set; }

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

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

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

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

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

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

        }

    }

}

C# C2BGetUnfinishedContractsRequest 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.

GET /api/C2BGetUnfinishedContracts HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"UnfinishedContracts":[{"CustomerName":"String","CustomerAcct":0,"StudentName":"String","Ref":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"District":"String","School":"String","Teacher":"String","Instrument":"String","Status":"String","Notes":"String","LockedBy":"String","InstrumentGrade":"String","Serial":"String","Salesperson":"String","WebNotes":"String","Email":"String","Phone":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","FirstDue":"0001-01-01T00:00:00.0000000","Accessories":[{"Id":0,"Description":"String","Price":0,"Type":"String","Sku":"String","Category":0,"Delivered":false}],"DownPay":0,"MonthlyPay":0,"DownMaint":0,"MonthlyMaint":0,"DownLease":0,"MonthlyLease":0,"DownTotal":0,"Address":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","InvoiceCreated":false,"ContractCreated":false}],"Topic":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}