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

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

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { 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>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")]
        public virtual string Token { 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 .xml suffix or ?format=xml

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceTicketFullDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Tickets>
    <TicketInfo>
      <ApprovedAmount>0</ApprovedAmount>
      <ApprovedDate>0001-01-01T00:00:00</ApprovedDate>
      <BillToCustomerAcct>0</BillToCustomerAcct>
      <BillToCustomerName>String</BillToCustomerName>
      <BilledDate>0001-01-01T00:00:00</BilledDate>
      <Category>0</Category>
      <CategoryDescription>String</CategoryDescription>
      <Contact>String</Contact>
      <Deposits>
        <DepositInfo>
          <Amount>0</Amount>
          <OriginalAmount>0</OriginalAmount>
          <RefNumber>String</RefNumber>
        </DepositInfo>
      </Deposits>
      <Invoiced>false</Invoiced>
      <Item>String</Item>
      <ItemDescription>String</ItemDescription>
      <Manufacturer>String</Manufacturer>
      <MasterNumber>String</MasterNumber>
      <Model>String</Model>
      <Notes>String</Notes>
      <PoNumber>String</PoNumber>
      <RefNumber>String</RefNumber>
      <ReturnAuthorizationNumber>String</ReturnAuthorizationNumber>
      <Services>
        <ServiceInfo>
          <Category>0</Category>
          <CategoryDescription>String</CategoryDescription>
          <Completed>false</Completed>
          <CompletedDate>0001-01-01T00:00:00</CompletedDate>
          <Description>String</Description>
          <Discount>0</Discount>
          <Id>0</Id>
          <Notes>String</Notes>
          <Parts>
            <PartInfo>
              <Category>0</Category>
              <CategoryDescription>String</CategoryDescription>
              <Description>String</Description>
              <Discount>0</Discount>
              <Notes>String</Notes>
              <Price>0</Price>
              <Quantity>0</Quantity>
              <Sku>String</Sku>
              <Total>0</Total>
            </PartInfo>
          </Parts>
          <Quantity>0</Quantity>
          <Rate>0</Rate>
          <Technician>String</Technician>
          <Time>0</Time>
          <TimerActive>false</TimerActive>
          <TimerStartTime>0001-01-01T00:00:00</TimerStartTime>
          <Total>0</Total>
        </ServiceInfo>
      </Services>
      <ShipToId>0</ShipToId>
      <ShipToName>String</ShipToName>
      <SoldToCustomerAcct>0</SoldToCustomerAcct>
      <SoldToCustomerName>String</SoldToCustomerName>
      <StLoc>String</StLoc>
      <Status>String</Status>
      <SubCategory>0</SubCategory>
      <SubCategoryDescription>String</SubCategoryDescription>
      <Subtotal>0</Subtotal>
      <Tax1>0</Tax1>
      <Tax2>0</Tax2>
      <TaxLoc>String</TaxLoc>
      <Terms>0</Terms>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TotalDue>0</TotalDue>
    </TicketInfo>
  </Tickets>
</ServiceTicketFullDetailsResponse>