AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class ExceptionInfo
            <DataMember>
            Public Overridable Property Barcode As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Base64Image As String

            <DataMember>
            Public Overridable Property Category As Integer

            <DataMember>
            Public Overridable Property SubCategory As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class PosLineItem
            Implements IScanItem
            <DataMember>
            Public Overridable Property SkuPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property SasPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property ExceptionInfo As ExceptionInfo

            <DataMember>
            Public Overridable Property Discount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property NicsCat As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property NicsSub As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property PriceOverride As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property AllowPriceOverrideToIgnoreMinPrice As Boolean

            <DataMember>
            Public Overridable Property Notes As String
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class PosResponseItem
            Inherits PosLineItem
            <DataMember>
            Public Overridable Property PriceEach As Decimal

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property Discountable As Boolean

            <DataMember>
            Public Overridable Property ErrorMessage As String
        End Class

        '''<Summary>
        '''In development, not yet for public use.
        '''</Summary>
        <DataContract>
        Public Partial Class SubmitPOSTransactionRequest
            Inherits BaseSecureRequest
            Public Sub New()
                Items = New List(Of PosLineItem)
            End Sub

            <DataMember>
            Public Overridable Property Acct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property LocId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property TaxId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Items As List(Of PosLineItem)

            '''<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 Overridable Property TenderType As String

            '''<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 Overridable Property OtherTenderCategory As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property CardToken As String

            <DataMember>
            Public Overridable Property CardExpiration As String

            <DataMember>
            Public Overridable Property TokenPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property SaveCard As Boolean

            <DataMember>
            Public Overridable Property PONumber As String

            '''<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 Overridable Property TransactionMode As String

            '''<Summary>
            '''Only valid for Approvals and Orders.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Only valid for Approvals and Orders.", Name:="Deposit", ParameterType:="query")>
            Public Overridable Property Deposit As Decimal

            <DataMember>
            Public Overridable Property Notes As String

            '''<Summary>
            '''Do Not Send This Parameter
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Do Not Send This Parameter", Name:="OnlineContractRef", ParameterType:="query")>
            Public Overridable Property OnlineContractRef As String

            <DataMember>
            Public Overridable Property ShipId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property CardTerminalId As String
        End Class

        <DataContract>
        Public Partial Class SubmitPOSTransactionResponse
            Inherits BaseResponse
            Public Sub New()
                ErrorItems = New List(Of PosResponseItem)
            End Sub

            <DataMember>
            Public Overridable Property RefNumber As String

            <DataMember>
            Public Overridable Property ErrorItems As List(Of PosResponseItem)
        End Class
    End Namespace
End Namespace

VB.NET SubmitPOSTransactionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"LocId":0,"TaxId":0,"Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"TenderType":"String","OtherTenderCategory":0,"CardToken":"String","CardExpiration":"String","TokenPk":0,"SaveCard":false,"PONumber":"String","TransactionMode":"String","Deposit":0,"Notes":"String","OnlineContractRef":"String","ShipId":0,"CardTerminalId":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"RefNumber":"String","ErrorItems":[{"PriceEach":0,"Price":0,"Discountable":false,"ErrorMessage":"String","SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}