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

            '''<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 Overridable Property OAuthToken As String

            '''<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 Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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>
            '''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 Overridable Property Token As String
        End Class

        Public Partial Class DepositInfo
            <DataMember>
            Public Overridable Property OriginalAmount As Decimal

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property RefNumber As String
        End Class

        Public Partial Class PartInfo
            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property Discount As Decimal

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Category As Integer

            <DataMember>
            Public Overridable Property CategoryDescription As String

            <DataMember>
            Public Overridable Property Sku As String
        End Class

        Public Partial Class ServiceInfo
            Public Sub New()
                Parts = New List(Of PartInfo)
            End Sub

            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Parts As List(Of PartInfo)

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Rate As Decimal

            <DataMember>
            Public Overridable Property Discount As Decimal

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property Time As Decimal

            <DataMember>
            Public Overridable Property Completed As Boolean

            <DataMember>
            Public Overridable Property CompletedDate As Date

            <DataMember>
            Public Overridable Property Technician As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Category As Integer

            <DataMember>
            Public Overridable Property CategoryDescription As String

            <DataMember>
            Public Overridable Property TimerActive As Boolean

            <DataMember>
            Public Overridable Property TimerStartTime As Nullable(Of Date)
        End Class

        '''<Summary>
        '''ServiceTicketFullDetailsRequires active-e Service Tickets Service
        '''</Summary>
        <DataContract>
        Public Partial Class ServiceTicketFullDetailsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Acct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property RefNumber As String

            <DataMember>
            Public Overridable Property ChangedDate As Nullable(Of Date)
        End Class

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

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

        <DataContract>
        Public Partial Class TicketInfo
            Public Sub New()
                Services = New List(Of ServiceInfo)
                Deposits = New List(Of DepositInfo)
            End Sub

            <DataMember>
            Public Overridable Property Terms As Integer

            <DataMember>
            Public Overridable Property PoNumber As String

            <DataMember>
            Public Overridable Property ReturnAuthorizationNumber As String

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property ApprovedAmount As Decimal

            <DataMember>
            Public Overridable Property TotalDue As Decimal

            <DataMember>
            Public Overridable Property Subtotal As Decimal

            <DataMember>
            Public Overridable Property Tax1 As Decimal

            <DataMember>
            Public Overridable Property Tax2 As Decimal

            <DataMember>
            Public Overridable Property ApprovedDate As Date

            <DataMember>
            Public Overridable Property BilledDate As Date

            <DataMember>
            Public Overridable Property Contact As String

            <DataMember>
            Public Overridable Property Category As Integer

            <DataMember>
            Public Overridable Property Services As List(Of ServiceInfo)

            <DataMember>
            Public Overridable Property CategoryDescription As String

            <DataMember>
            Public Overridable Property SubCategory As Integer

            <DataMember>
            Public Overridable Property SubCategoryDescription As String

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property ItemDescription As String

            <DataMember>
            Public Overridable Property Manufacturer As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Timestamp As Date

            <DataMember>
            Public Overridable Property SoldToCustomerAcct As Integer

            <DataMember>
            Public Overridable Property BillToCustomerAcct As Integer

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property StLoc As String

            <DataMember>
            Public Overridable Property TaxLoc As String

            <DataMember>
            Public Overridable Property RefNumber As String

            <DataMember>
            Public Overridable Property MasterNumber As String

            <DataMember>
            Public Overridable Property Invoiced As Boolean

            <DataMember>
            Public Overridable Property Deposits As List(Of DepositInfo)

            <DataMember>
            Public Overridable Property SoldToCustomerName As String

            <DataMember>
            Public Overridable Property BillToCustomerName As String

            <DataMember>
            Public Overridable Property ShipToName As String

            <DataMember>
            Public Overridable Property ShipToId As Nullable(Of Long)
        End Class
    End Namespace
End Namespace

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