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.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
    {
        public C2BGetUnfinishedContractsResponse()
        {
            UnfinishedContracts = new List<UnfinishedContract>{};
        }

        [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
        {
            public UnfinishedContract()
            {
                Accessories = new List<C2BAccessory>{};
            }

            [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 .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.

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

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

<C2BGetUnfinishedContractsResponse 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>
  <BaseUrl>String</BaseUrl>
  <Topic>String</Topic>
  <UnfinishedContracts>
    <C2BGetUnfinishedContractsResponse.UnfinishedContract>
      <Accessories>
        <C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
          <Category>0</Category>
          <Delivered>false</Delivered>
          <Description>String</Description>
          <Id>0</Id>
          <Price>0</Price>
          <Sku>String</Sku>
          <Type>String</Type>
        </C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
      </Accessories>
      <Address>String</Address>
      <Address2>String</Address2>
      <City>String</City>
      <ContractCreated>false</ContractCreated>
      <Country>String</Country>
      <CustomerAcct>0</CustomerAcct>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <District>String</District>
      <DownLease>0</DownLease>
      <DownMaint>0</DownMaint>
      <DownPay>0</DownPay>
      <DownTotal>0</DownTotal>
      <Email>String</Email>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <Instrument>String</Instrument>
      <InstrumentGrade>String</InstrumentGrade>
      <InvoiceCreated>false</InvoiceCreated>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <LockedBy>String</LockedBy>
      <MonthlyLease>0</MonthlyLease>
      <MonthlyMaint>0</MonthlyMaint>
      <MonthlyPay>0</MonthlyPay>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Ref>String</Ref>
      <Salesperson>String</Salesperson>
      <School>String</School>
      <Serial>String</Serial>
      <State>String</State>
      <Status>String</Status>
      <StudentName>String</StudentName>
      <Teacher>String</Teacher>
      <WebNotes>String</WebNotes>
      <Zip>String</Zip>
    </C2BGetUnfinishedContractsResponse.UnfinishedContract>
  </UnfinishedContracts>
</C2BGetUnfinishedContractsResponse>