AIM Web Services

<back to all web services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/History360
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

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; }
    }

    [DataContract]
    public partial class Contract360
    {
        public Contract360()
        {
            ContractItems = new List<Item360>{};
        }

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual List<Item360> ContractItems { get; set; }
    }

    ///<summary>
    ///History360Requires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class History360Request
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int CustomerAccount { get; set; }

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

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

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

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

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

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

    [DataContract]
    public partial class History360Response
        : BaseResponse
    {
        public History360Response()
        {
            Invoices = new List<Invoice360>{};
            Orders = new List<Order360>{};
            WorkOrders = new List<WorkOrder360>{};
            Contracts = new List<Contract360>{};
        }

        [DataMember]
        public virtual List<Invoice360> Invoices { get; set; }

        [DataMember]
        public virtual List<Order360> Orders { get; set; }

        [DataMember]
        public virtual List<WorkOrder360> WorkOrders { get; set; }

        [DataMember]
        public virtual List<Contract360> Contracts { get; set; }
    }

    [DataContract]
    public partial class Invoice360
    {
        public Invoice360()
        {
            Items = new List<Item360>{};
        }

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual List<Item360> Items { get; set; }
    }

    [DataContract]
    public partial class Item360
    {
        [DataMember]
        public virtual long? PslrId { get; set; }

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

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

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

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

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

    [DataContract]
    public partial class Job360
    {
        [DataMember]
        public virtual string ItemId { get; set; }

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

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

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

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

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

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

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

    [DataContract]
    public partial class Order360
    {
        [DataMember]
        public virtual int Id { get; set; }

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

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

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

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

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

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

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

    [DataContract]
    public partial class WorkOrder360
    {
        public WorkOrder360()
        {
            Jobs = new List<Job360>{};
        }

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual List<Job360> Jobs { get; set; }
    }

}

C# History360Request 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/History360 HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<History360Response 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>
  <Contracts>
    <Contract360>
      <Amount>0</Amount>
      <AmountDue>0</AmountDue>
      <ContractItems>
        <Item360>
          <Condition>String</Condition>
          <Price>0</Price>
          <PslrId>0</PslrId>
          <Quantity>0</Quantity>
          <SerialNumber>String</SerialNumber>
          <TotalDiscountAmount>0</TotalDiscountAmount>
        </Item360>
      </ContractItems>
      <ContractStatus>String</ContractStatus>
      <Id>String</Id>
      <LateFee>0</LateFee>
      <LocationName>String</LocationName>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <StoreLocationId>0</StoreLocationId>
    </Contract360>
  </Contracts>
  <Invoices>
    <Invoice360>
      <AmountPaid>0</AmountPaid>
      <Discount>0</Discount>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <Id>String</Id>
      <Items>
        <Item360>
          <Condition>String</Condition>
          <Price>0</Price>
          <PslrId>0</PslrId>
          <Quantity>0</Quantity>
          <SerialNumber>String</SerialNumber>
          <TotalDiscountAmount>0</TotalDiscountAmount>
        </Item360>
      </Items>
      <LateFeeAmount>0</LateFeeAmount>
      <PaymentType>String</PaymentType>
      <PurchaseDate>0001-01-01T00:00:00</PurchaseDate>
      <Shipping>0</Shipping>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
      <Tax>0</Tax>
      <Total>0</Total>
    </Invoice360>
  </Invoices>
  <Orders>
    <Order360>
      <Date>0001-01-01T00:00:00</Date>
      <Discount>0</Discount>
      <Id>0</Id>
      <PaymentType>String</PaymentType>
      <ShippingAmount>0</ShippingAmount>
      <SubTotal>0</SubTotal>
      <Tax>0</Tax>
      <Total>0</Total>
    </Order360>
  </Orders>
  <WorkOrders>
    <WorkOrder360>
      <CompletedDate>0001-01-01T00:00:00</CompletedDate>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <Deposit>0</Deposit>
      <Id>String</Id>
      <Jobs>
        <Job360>
          <Condition>String</Condition>
          <ItemId>String</ItemId>
          <ItemType>String</ItemType>
          <Price>0</Price>
          <Quantity>0</Quantity>
          <SerialNumber>String</SerialNumber>
          <Title>String</Title>
          <TotalDiscountAmount>0</TotalDiscountAmount>
        </Job360>
      </Jobs>
      <LocationName>String</LocationName>
      <Price>0</Price>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
    </WorkOrder360>
  </WorkOrders>
</History360Response>