AIM Web Services

GetPOSTotalsRequest

In development, not yet for public use.

The following routes are available for this service:
POST	/api/GetPOSTotals

import Foundation
import ServiceStack

/**
* In development, not yet for public use.
*/
// @DataContract
public class GetPOSTotalsRequest : BaseSecureRequest
{
    // @DataMember
    public var acct:Int?

    // @DataMember
    public var locId:Int?

    // @DataMember
    public var taxId:Int?

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

    /**
    * MANUAL, BLANKET_PERCENT, BLANKET_AMOUNT, BACK_INTO_TOTAL, or BACK_INTO_TOTAL_WITH_TAX. Defaults to Manual. No line item discounts can be set unless this is MANUAL.
    */
    // @DataMember
    // @ApiMember(Description="MANUAL, BLANKET_PERCENT, BLANKET_AMOUNT, BACK_INTO_TOTAL, or BACK_INTO_TOTAL_WITH_TAX. Defaults to Manual. No line item discounts can be set unless this is MANUAL.", Name="DiscountMode", ParameterType="query")
    public var discountMode:String

    // @DataMember
    public var discountDetail:Double?

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

    private enum CodingKeys : String, CodingKey {
        case acct
        case locId
        case taxId
        case items
        case discountMode
        case discountDetail
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        locId = try container.decodeIfPresent(Int.self, forKey: .locId)
        taxId = try container.decodeIfPresent(Int.self, forKey: .taxId)
        items = try container.decodeIfPresent([PosLineItem].self, forKey: .items) ?? []
        discountMode = try container.decodeIfPresent(String.self, forKey: .discountMode)
        discountDetail = try container.decodeIfPresent(Double.self, forKey: .discountDetail)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if locId != nil { try container.encode(locId, forKey: .locId) }
        if taxId != nil { try container.encode(taxId, forKey: .taxId) }
        if items.count > 0 { try container.encode(items, forKey: .items) }
        if discountMode != nil { try container.encode(discountMode, forKey: .discountMode) }
        if discountDetail != nil { try container.encode(discountDetail, forKey: .discountDetail) }
    }
}

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

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

    private enum CodingKeys : String, CodingKey {
        case token
    }

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

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

// @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

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

    /**
    * 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 var deviceId:String

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

    required public init(){}
}

// @DataContract
public class PosLineItem : IScanItem, Codable
{
    // @DataMember
    public var skuPk:Int?

    // @DataMember
    public var sasPk:Int?

    // @DataMember
    public var sku:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var exceptionInfo:ExceptionInfo

    // @DataMember
    public var discount:Double?

    // @DataMember
    public var nicsCat:Int?

    // @DataMember
    public var nicsSub:Int?

    // @DataMember
    public var priceOverride:Double?

    // @DataMember
    public var allowPriceOverrideToIgnoreMinPrice:Bool

    // @DataMember
    public var notes:String

    required public init(){}
}

// @DataContract
public class ExceptionInfo : Codable
{
    // @DataMember
    public var barcode:String

    // @DataMember
    public var Description:String

    // @DataMember
    public var base64Image:String

    // @DataMember
    public var category:Int

    // @DataMember
    public var subCategory:Int?

    required public init(){}
}

// @DataContract
public class GetPOSTotalsResponse : BaseResponse
{
    // @DataMember
    public var subTotal:Double

    // @DataMember
    public var taxTotal:Double

    // @DataMember
    public var total:Double

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

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

    private enum CodingKeys : String, CodingKey {
        case subTotal
        case taxTotal
        case total
        case items
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        subTotal = try container.decodeIfPresent(Double.self, forKey: .subTotal)
        taxTotal = try container.decodeIfPresent(Double.self, forKey: .taxTotal)
        total = try container.decodeIfPresent(Double.self, forKey: .total)
        items = try container.decodeIfPresent([PosResponseItem].self, forKey: .items) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if subTotal != nil { try container.encode(subTotal, forKey: .subTotal) }
        if taxTotal != nil { try container.encode(taxTotal, forKey: .taxTotal) }
        if total != nil { try container.encode(total, forKey: .total) }
        if items.count > 0 { try container.encode(items, forKey: .items) }
    }
}

// @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 PosResponseItem : PosLineItem
{
    // @DataMember
    public var priceEach:Double

    // @DataMember
    public var price:Double

    // @DataMember
    public var discountable:Bool

    // @DataMember
    public var errorMessage:String

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

    private enum CodingKeys : String, CodingKey {
        case priceEach
        case price
        case discountable
        case errorMessage
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        priceEach = try container.decodeIfPresent(Double.self, forKey: .priceEach)
        price = try container.decodeIfPresent(Double.self, forKey: .price)
        discountable = try container.decodeIfPresent(Bool.self, forKey: .discountable)
        errorMessage = try container.decodeIfPresent(String.self, forKey: .errorMessage)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if priceEach != nil { try container.encode(priceEach, forKey: .priceEach) }
        if price != nil { try container.encode(price, forKey: .price) }
        if discountable != nil { try container.encode(discountable, forKey: .discountable) }
        if errorMessage != nil { try container.encode(errorMessage, forKey: .errorMessage) }
    }
}

Swift GetPOSTotalsRequest 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.

POST /api/GetPOSTotals HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPOSTotalsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <Acct>0</Acct>
  <DiscountDetail>0</DiscountDetail>
  <DiscountMode>String</DiscountMode>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:PosLineItem>
      <d2p1:AllowPriceOverrideToIgnoreMinPrice>false</d2p1:AllowPriceOverrideToIgnoreMinPrice>
      <d2p1:Discount>0</d2p1:Discount>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:NicsCat>0</d2p1:NicsCat>
      <d2p1:NicsSub>0</d2p1:NicsSub>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PriceOverride>0</d2p1:PriceOverride>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:PosLineItem>
  </Items>
  <LocId>0</LocId>
  <TaxId>0</TaxId>
</GetPOSTotalsRequest>

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

<GetPOSTotalsResponse 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>
  <Items>
    <PosResponseItem>
      <AllowPriceOverrideToIgnoreMinPrice xmlns="http://schemas.datacontract.org/2004/07/AIM">false</AllowPriceOverrideToIgnoreMinPrice>
      <Discount xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Discount>
      <ExceptionInfo xmlns="http://schemas.datacontract.org/2004/07/AIM">
        <Barcode>String</Barcode>
        <Base64Image>String</Base64Image>
        <Category>0</Category>
        <Description>String</Description>
        <SubCategory>0</SubCategory>
      </ExceptionInfo>
      <NicsCat xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsCat>
      <NicsSub xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsSub>
      <Notes xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Notes>
      <PriceOverride xmlns="http://schemas.datacontract.org/2004/07/AIM">0</PriceOverride>
      <Quantity xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Quantity>
      <SasPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SasPk>
      <Serial xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Serial>
      <Sku xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Sku>
      <SkuPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SkuPk>
      <Discountable>false</Discountable>
      <ErrorMessage>String</ErrorMessage>
      <Price>0</Price>
      <PriceEach>0</PriceEach>
    </PosResponseItem>
  </Items>
  <SubTotal>0</SubTotal>
  <TaxTotal>0</TaxTotal>
  <Total>0</Total>
</GetPOSTotalsResponse>