AIM Web Services

<back to all web services

PrintDeliveryTicketRequest

PrintDeliveryTicket
Requires active-e Customer Service

The following routes are available for this service:
GET/api/PrintDeliveryTicket
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 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

        '''<Summary>
        '''PrintDeliveryTicketRequires active-e Customer Service
        '''</Summary>
        <DataContract>
        Public Partial Class PrintDeliveryTicketRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Ref As String

            '''<Summary>
            '''Can be STREAM, PRINT, or EMAIL. Defaults to STREAM
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Can be STREAM, PRINT, or EMAIL. Defaults to STREAM", Name:="OutputType", ParameterType:="query")>
            Public Overridable Property OutputType As String

            '''<Summary>
            '''Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Only applies to OutputTypes of PRINT and EMAIL. The listening workstation to handle the request.", Name:="OutputWorkstation", ParameterType:="query")>
            Public Overridable Property OutputWorkstation As Nullable(Of Integer)

            '''<Summary>
            '''Only applies to OutputType of EMAIL. The email address to send to.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Only applies to OutputType of EMAIL. The email address to send to.", Name:="OutputTo", ParameterType:="query")>
            Public Overridable Property OutputTo As String

            '''<Summary>
            '''Only applies to employee logins. Customer account of the delivery ticket.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Only applies to employee logins. Customer account of the delivery ticket.", Name:="CustomerAcct", ParameterType:="query")>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class PrintDeliveryTicketResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property PdfStream As String

            <DataMember>
            Public Overridable Property EmailSubject As String

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

VB.NET PrintDeliveryTicketRequest 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/PrintDeliveryTicket HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"PdfStream":"String","EmailSubject":"String","EmailBody":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}