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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Item360
{
    // @DataMember
    public PslrId?: number;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public TotalDiscountAmount: number;

    // @DataMember
    public SerialNumber: string;

    // @DataMember
    public Condition: string;

    public constructor(init?: Partial<Item360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Invoice360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public DueDate?: string;

    // @DataMember
    public Total: number;

    // @DataMember
    public Status: string;

    // @DataMember
    public AmountPaid: number;

    // @DataMember
    public PaymentType: string;

    // @DataMember
    public LateFeeAmount: number;

    // @DataMember
    public PurchaseDate: string;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public Discount: number;

    // @DataMember
    public Tax: number;

    // @DataMember
    public Shipping: number;

    // @DataMember
    public Items: Item360[];

    public constructor(init?: Partial<Invoice360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Order360
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Date: string;

    // @DataMember
    public Discount: number;

    // @DataMember
    public PaymentType: string;

    // @DataMember
    public SubTotal: number;

    // @DataMember
    public Tax: number;

    // @DataMember
    public ShippingAmount: number;

    // @DataMember
    public Total: number;

    public constructor(init?: Partial<Order360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Job360
{
    // @DataMember
    public ItemId: string;

    // @DataMember
    public ItemType: string;

    // @DataMember
    public Title: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public TotalDiscountAmount: number;

    // @DataMember
    public SerialNumber: string;

    // @DataMember
    public Condition: string;

    public constructor(init?: Partial<Job360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WorkOrder360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public Status: string;

    // @DataMember
    public Deposit: number;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public CreationDate: string;

    // @DataMember
    public CompletedDate?: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public LocationName: string;

    // @DataMember
    public Jobs: Job360[];

    public constructor(init?: Partial<WorkOrder360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Contract360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public PaymentDate: string;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public AmountDue: number;

    // @DataMember
    public LateFee: number;

    // @DataMember
    public ContractStatus: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public LocationName: string;

    // @DataMember
    public ContractItems: Item360[];

    public constructor(init?: Partial<Contract360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class History360Response extends BaseResponse
{
    // @DataMember
    public Invoices: Invoice360[];

    // @DataMember
    public Orders: Order360[];

    // @DataMember
    public WorkOrders: WorkOrder360[];

    // @DataMember
    public Contracts: Contract360[];

    public constructor(init?: Partial<History360Response>) { super(init); (Object as any).assign(this, init); }
}

/** @description History360Requires active-e Customer Service. */
// @DataContract
export class History360Request extends BaseSecureRequest
{
    // @DataMember
    public CustomerAccount: number;

    // @DataMember
    public IncludeInvoices: boolean;

    // @DataMember
    public IncludeOrders: boolean;

    // @DataMember
    public IncludeWorkOrders: boolean;

    // @DataMember
    public IncludeContracts: boolean;

    // @DataMember
    public IncludeClosed: boolean;

    // @DataMember
    public ClosedStartDate?: string;

    public constructor(init?: Partial<History360Request>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>