AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

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

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 ExceptionInfo
    {
        [DataMember]
        public virtual string Barcode { get; set; }

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

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

        [DataMember]
        public virtual int Category { get; set; }

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

    [DataContract]
    public partial class PosLineItem
        : IScanItem
    {
        [DataMember]
        public virtual long? SkuPk { get; set; }

        [DataMember]
        public virtual long? SasPk { get; set; }

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

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

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

        [DataMember]
        public virtual ExceptionInfo ExceptionInfo { get; set; }

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

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

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

        [DataMember]
        public virtual decimal? PriceOverride { get; set; }

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

        [DataMember]
        public virtual string Notes { 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; }
    }

    [DataContract]
    public partial class PosResponseItem
        : PosLineItem
    {
        [DataMember]
        public virtual decimal PriceEach { get; set; }

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

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

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

    ///<summary>
    ///In development, not yet for public use.
    ///</summary>
    [DataContract]
    public partial class SubmitPOSTransactionRequest
        : BaseSecureRequest
    {
        public SubmitPOSTransactionRequest()
        {
            Items = new List<PosLineItem>{};
        }

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

        [DataMember]
        public virtual long? LocId { get; set; }

        [DataMember]
        public virtual long? TaxId { get; set; }

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

        ///<summary>
        ///Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER", Name="TenderType", ParameterType="query")]
        public virtual string TenderType { get; set; }

        ///<summary>
        ///Only applicable for Tender Type of OTHER. Send the Payment Category #
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Only applicable for Tender Type of OTHER. Send the Payment Category #", Name="OtherTenderCategory", ParameterType="query")]
        public virtual int? OtherTenderCategory { get; set; }

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

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

        [DataMember]
        public virtual long? TokenPk { get; set; }

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

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

        ///<summary>
        ///Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.", Name="TransactionMode", ParameterType="query")]
        public virtual string TransactionMode { get; set; }

        ///<summary>
        ///Only valid for Approvals and Orders.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="decimal", Description="Only valid for Approvals and Orders.", Name="Deposit", ParameterType="query")]
        public virtual decimal Deposit { get; set; }

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

        ///<summary>
        ///Do Not Send This Parameter
        ///</summary>
        [DataMember]
        [ApiMember(Description="Do Not Send This Parameter", Name="OnlineContractRef", ParameterType="query")]
        public virtual string OnlineContractRef { get; set; }

        [DataMember]
        public virtual long? ShipId { get; set; }

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

    [DataContract]
    public partial class SubmitPOSTransactionResponse
        : BaseResponse
    {
        public SubmitPOSTransactionResponse()
        {
            ErrorItems = new List<PosResponseItem>{};
        }

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

        [DataMember]
        public virtual List<PosResponseItem> ErrorItems { get; set; }
    }

}

C# SubmitPOSTransactionRequest 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/SubmitPOSTransaction HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubmitPOSTransactionRequest 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>
  <CardExpiration>String</CardExpiration>
  <CardTerminalId>String</CardTerminalId>
  <CardToken>String</CardToken>
  <Deposit>0</Deposit>
  <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>
  <Notes>String</Notes>
  <OnlineContractRef>String</OnlineContractRef>
  <OtherTenderCategory>0</OtherTenderCategory>
  <PONumber>String</PONumber>
  <SaveCard>false</SaveCard>
  <ShipId>0</ShipId>
  <TaxId>0</TaxId>
  <TenderType>String</TenderType>
  <TokenPk>0</TokenPk>
  <TransactionMode>String</TransactionMode>
</SubmitPOSTransactionRequest>

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

<SubmitPOSTransactionResponse 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>
  <ErrorItems>
    <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>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</SubmitPOSTransactionResponse>