AIM Web Services

<back to all web services

ServiceTicketFullDetailsRequest

ServiceTicketFullDetails
Requires active-e Service Tickets Service

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

    public partial class DepositInfo
    {
        [DataMember]
        public virtual decimal OriginalAmount { get; set; }

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

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

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

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

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

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

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

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

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

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

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

    public partial class ServiceInfo
    {
        public ServiceInfo()
        {
            Parts = new List<PartInfo>{};
        }

        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual List<PartInfo> Parts { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    ///<summary>
    ///ServiceTicketFullDetailsRequires active-e Service Tickets Service
    ///</summary>
    [DataContract]
    public partial class ServiceTicketFullDetailsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int? Acct { get; set; }

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

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

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

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

    [DataContract]
    public partial class TicketInfo
    {
        public TicketInfo()
        {
            Services = new List<ServiceInfo>{};
            Deposits = new List<DepositInfo>{};
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual List<ServiceInfo> Services { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [DataMember]
        public virtual List<DepositInfo> Deposits { get; set; }

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

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

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

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

}

C# ServiceTicketFullDetailsRequest 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/ServiceTicketFullDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"Tickets":[{"Terms":0,"PoNumber":"String","ReturnAuthorizationNumber":"String","Status":"String","ApprovedAmount":0,"TotalDue":0,"Subtotal":0,"Tax1":0,"Tax2":0,"Contact":"String","Category":0,"Services":[{"Id":0,"Parts":[{"Description":"String","Quantity":0,"Price":0,"Discount":0,"Total":0,"Notes":"String","Category":0,"CategoryDescription":"String","Sku":"String"}],"Description":"String","Quantity":0,"Rate":0,"Discount":0,"Total":0,"Time":0,"Completed":false,"Technician":"String","Notes":"String","Category":0,"CategoryDescription":"String","TimerActive":false,"TimerStartTime":"0001-01-01T00:00:00.0000000"}],"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Item":"String","ItemDescription":"String","Manufacturer":"String","Notes":"String","SoldToCustomerAcct":0,"BillToCustomerAcct":0,"Model":"String","StLoc":"String","TaxLoc":"String","RefNumber":"String","MasterNumber":"String","Invoiced":false,"Deposits":[{"OriginalAmount":0,"Amount":0,"RefNumber":"String"}],"SoldToCustomerName":"String","BillToCustomerName":"String","ShipToName":"String","ShipToId":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}