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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class Base64Image
    {
        [DataMember]
        public virtual string Data { get; set; }

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

    [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; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { 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>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class DeliveryItem
    {
        [DataMember]
        public virtual decimal Quantity { get; set; }

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

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

    [DataContract]
    public partial class DeliveryTicket
    {
        public DeliveryTicket()
        {
            DependentAttributes = new List<DependentAttribute>{};
            Images = new List<Base64Image>{};
            DeliveryItems = new List<DeliveryItem>{};
        }

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

        [DataMember]
        public virtual DateTime Date { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual DateTime CreatedDate { get; set; }

        [DataMember]
        public virtual List<DependentAttribute> DependentAttributes { get; set; }

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

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

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

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

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

        [DataMember]
        public virtual List<Base64Image> Images { get; set; }

        [DataMember]
        public virtual List<DeliveryItem> DeliveryItems { get; set; }
    }

    ///<summary>
    ///DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    ///</summary>
    [DataContract]
    public partial class DeliveryTicketsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual DateTime? DateFrom { get; set; }

        [DataMember]
        public virtual DateTime? DateTo { get; set; }

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

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

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

        ///<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 virtual string TicketType { get; set; }

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

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

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

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

    [DataContract]
    public partial class DeliveryTicketsResponse
        : BaseResponse
    {
        public DeliveryTicketsResponse()
        {
            Tickets = new List<DeliveryTicket>{};
        }

        [DataMember]
        public virtual List<DeliveryTicket> Tickets { get; set; }
    }

    [DataContract]
    public partial class DependentAttribute
    {
        [DataMember]
        public virtual string Attribute { get; set; }

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

}

C# DeliveryTicketsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}