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
import Foundation
import ServiceStack

/**
* History360Requires active-e Customer Service.
*/
// @DataContract
public class History360Request : BaseSecureRequest
{
    // @DataMember
    public var customerAccount:Int

    // @DataMember
    public var includeInvoices:Bool

    // @DataMember
    public var includeOrders:Bool

    // @DataMember
    public var includeWorkOrders:Bool

    // @DataMember
    public var includeContracts:Bool

    // @DataMember
    public var includeClosed:Bool

    // @DataMember
    public var closedStartDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case customerAccount
        case includeInvoices
        case includeOrders
        case includeWorkOrders
        case includeContracts
        case includeClosed
        case closedStartDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        customerAccount = try container.decodeIfPresent(Int.self, forKey: .customerAccount)
        includeInvoices = try container.decodeIfPresent(Bool.self, forKey: .includeInvoices)
        includeOrders = try container.decodeIfPresent(Bool.self, forKey: .includeOrders)
        includeWorkOrders = try container.decodeIfPresent(Bool.self, forKey: .includeWorkOrders)
        includeContracts = try container.decodeIfPresent(Bool.self, forKey: .includeContracts)
        includeClosed = try container.decodeIfPresent(Bool.self, forKey: .includeClosed)
        closedStartDate = try container.decodeIfPresent(Date.self, forKey: .closedStartDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if customerAccount != nil { try container.encode(customerAccount, forKey: .customerAccount) }
        if includeInvoices != nil { try container.encode(includeInvoices, forKey: .includeInvoices) }
        if includeOrders != nil { try container.encode(includeOrders, forKey: .includeOrders) }
        if includeWorkOrders != nil { try container.encode(includeWorkOrders, forKey: .includeWorkOrders) }
        if includeContracts != nil { try container.encode(includeContracts, forKey: .includeContracts) }
        if includeClosed != nil { try container.encode(includeClosed, forKey: .includeClosed) }
        if closedStartDate != nil { try container.encode(closedStartDate, forKey: .closedStartDate) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class History360Response : BaseResponse
{
    // @DataMember
    public var invoices:[Invoice360] = []

    // @DataMember
    public var orders:[Order360] = []

    // @DataMember
    public var workOrders:[WorkOrder360] = []

    // @DataMember
    public var contracts:[Contract360] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case invoices
        case orders
        case workOrders
        case contracts
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        invoices = try container.decodeIfPresent([Invoice360].self, forKey: .invoices) ?? []
        orders = try container.decodeIfPresent([Order360].self, forKey: .orders) ?? []
        workOrders = try container.decodeIfPresent([WorkOrder360].self, forKey: .workOrders) ?? []
        contracts = try container.decodeIfPresent([Contract360].self, forKey: .contracts) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if invoices.count > 0 { try container.encode(invoices, forKey: .invoices) }
        if orders.count > 0 { try container.encode(orders, forKey: .orders) }
        if workOrders.count > 0 { try container.encode(workOrders, forKey: .workOrders) }
        if contracts.count > 0 { try container.encode(contracts, forKey: .contracts) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class Invoice360 : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var dueDate:Date?

    // @DataMember
    public var total:Double

    // @DataMember
    public var status:String

    // @DataMember
    public var amountPaid:Double

    // @DataMember
    public var lateFeeAmount:Double

    // @DataMember
    public var purchaseDate:Date

    // @DataMember
    public var storeLocationId:Int?

    // @DataMember
    public var items:[Item360] = []

    required public init(){}
}

// @DataContract
public class Item360 : Codable
{
    // @DataMember
    public var pslrId:Int?

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var price:Double

    // @DataMember
    public var totalDiscountAmount:Double

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var condition:String

    required public init(){}
}

// @DataContract
public class Order360 : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var date:Date

    // @DataMember
    public var discount:Double

    // @DataMember
    public var paymentType:String

    // @DataMember
    public var subTotal:Double

    // @DataMember
    public var tax:Double

    // @DataMember
    public var shippingAmount:Double

    // @DataMember
    public var total:Double

    required public init(){}
}

// @DataContract
public class WorkOrder360 : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var status:String

    // @DataMember
    public var deposit:Double

    // @DataMember
    public var storeLocationId:Int?

    // @DataMember
    public var creationDate:Date

    // @DataMember
    public var completedDate:Date?

    // @DataMember
    public var price:Double

    // @DataMember
    public var jobs:[Job360] = []

    required public init(){}
}

// @DataContract
public class Job360 : Codable
{
    // @DataMember
    public var itemId:String

    // @DataMember
    public var itemType:String

    // @DataMember
    public var title:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var price:Double

    // @DataMember
    public var totalDiscountAmount:Double

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var condition:String

    required public init(){}
}

// @DataContract
public class Contract360 : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var paymentDate:Date

    // @DataMember
    public var storeLocationId:Int?

    // @DataMember
    public var amountDue:Double

    // @DataMember
    public var lateFee:Double

    // @DataMember
    public var contractStatus:String

    // @DataMember
    public var amount:Double

    // @DataMember
    public var contractItems:[Item360] = []

    required public init(){}
}

Swift 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>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <StoreLocationId>0</StoreLocationId>
    </Contract360>
  </Contracts>
  <Invoices>
    <Invoice360>
      <AmountPaid>0</AmountPaid>
      <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>
      <PurchaseDate>0001-01-01T00:00:00</PurchaseDate>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
      <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>
      <Price>0</Price>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
    </WorkOrder360>
  </WorkOrders>
</History360Response>