AIM Web Services

<back to all web services

DeliveryTicketsRequest

DeliveryTickets
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/DeliveryTickets
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class Base64Image
            <DataMember>
            Public Overridable Property Data As String

            <DataMember>
            Public Overridable Property FileName As String
        End Class

        <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 DeliveryItem
            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Description As String
        End Class

        <DataContract>
        Public Partial Class DeliveryTicket
            Public Sub New()
                DependentAttributes = New List(Of DependentAttribute)
                Images = New List(Of Base64Image)
                DeliveryItems = New List(Of DeliveryItem)
            End Sub

            <DataMember>
            Public Overridable Property RefNumber As String

            <DataMember>
            Public Overridable Property [Date] As Date

            <DataMember>
            Public Overridable Property AccountNumber As Integer

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Address As String

            <DataMember>
            Public Overridable Property Address2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property State As String

            <DataMember>
            Public Overridable Property ZipCode As String

            <DataMember>
            Public Overridable Property Student As String

            <DataMember>
            Public Overridable Property Contact As String

            <DataMember>
            Public Overridable Property Delivered As Boolean

            <DataMember>
            Public Overridable Property District As String

            <DataMember>
            Public Overridable Property School As String

            <DataMember>
            Public Overridable Property DeliveryEmployee As String

            <DataMember>
            Public Overridable Property TimeFrame As String

            <DataMember>
            Public Overridable Property CreatedDate As Date

            <DataMember>
            Public Overridable Property DependentAttributes As List(Of DependentAttribute)

            <DataMember>
            Public Overridable Property TicketType As String

            <DataMember>
            Public Overridable Property HasImages As Boolean

            <DataMember>
            Public Overridable Property HasSignature As Boolean

            <DataMember>
            Public Overridable Property Base64Signature As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Images As List(Of Base64Image)

            <DataMember>
            Public Overridable Property DeliveryItems As List(Of DeliveryItem)
        End Class

        '''<Summary>
        '''DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
        '''</Summary>
        <DataContract>
        Public Partial Class DeliveryTicketsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property DateFrom As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DateTo As Nullable(Of Date)

            <DataMember>
            Public Overridable Property District As String

            <DataMember>
            Public Overridable Property School As String

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

            '''<Summary>
            '''Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval", IsRequired:=true, Name:="TicketType", ParameterType:="query")>
            Public Overridable Property TicketType As String

            <DataMember>
            Public Overridable Property EmployeeLanId As String

            <DataMember>
            Public Overridable Property DeliveryEmployeeLanId As String

            <DataMember>
            Public Overridable Property RefNumber As String

            <DataMember>
            Public Overridable Property IncludeItems As Boolean
        End Class

        <DataContract>
        Public Partial Class DeliveryTicketsResponse
            Inherits BaseResponse
            Public Sub New()
                Tickets = New List(Of DeliveryTicket)
            End Sub

            <DataMember>
            Public Overridable Property Tickets As List(Of DeliveryTicket)
        End Class

        <DataContract>
        Public Partial Class DependentAttribute
            <DataMember>
            Public Overridable Property Attribute As String

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

VB.NET DeliveryTicketsRequest 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.

GET /api/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"Tickets":[{"RefNumber":"String","AccountNumber":0,"Name":"String","Address":"String","Address2":"String","City":"String","State":"String","ZipCode":"String","Student":"String","Contact":"String","Delivered":false,"District":"String","School":"String","DeliveryEmployee":"String","TimeFrame":"String","DependentAttributes":[{"Attribute":"String","AttributeValue":"String"}],"TicketType":"String","HasImages":false,"HasSignature":false,"Base64Signature":"String","Notes":"String","Images":[{"Data":"String","FileName":"String"}],"DeliveryItems":[{"Quantity":0,"Item":"String","Description":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}