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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<AllowNullLiteral>]
    type PartInfo() = 
        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Discount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Total:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

    [<AllowNullLiteral>]
    type ServiceInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Parts:ResizeArray<PartInfo> = new ResizeArray<PartInfo>() with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Rate:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Discount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Total:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Time:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Completed:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CompletedDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Technician:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val TimerActive:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val TimerStartTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DepositInfo() = 
        [<DataMember>]
        member val OriginalAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Amount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type TicketInfo() = 
        [<DataMember>]
        member val Terms:Int32 = new Int32() with get,set

        [<DataMember>]
        member val PoNumber:String = null with get,set

        [<DataMember>]
        member val ReturnAuthorizationNumber:String = null with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val ApprovedAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TotalDue:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Subtotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Tax1:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Tax2:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ApprovedDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val BilledDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Contact:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Services:ResizeArray<ServiceInfo> = new ResizeArray<ServiceInfo>() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val SubCategory:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SubCategoryDescription:String = null with get,set

        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val ItemDescription:String = null with get,set

        [<DataMember>]
        member val Manufacturer:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Timestamp:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val SoldToCustomerAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val BillToCustomerAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val StLoc:String = null with get,set

        [<DataMember>]
        member val TaxLoc:String = null with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

        [<DataMember>]
        member val MasterNumber:String = null with get,set

        [<DataMember>]
        member val Invoiced:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Deposits:ResizeArray<DepositInfo> = new ResizeArray<DepositInfo>() with get,set

        [<DataMember>]
        member val SoldToCustomerName:String = null with get,set

        [<DataMember>]
        member val BillToCustomerName:String = null with get,set

        [<DataMember>]
        member val ShipToName:String = null with get,set

        [<DataMember>]
        member val ShipToId:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceTicketFullDetailsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Tickets:ResizeArray<TicketInfo> = new ResizeArray<TicketInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with 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")>]
        member val OAuthToken:String = null with 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")>]
        member val DeviceId:String = null with 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")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit 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")>]
        member val Token:String = null with get,set

    ///<summary>
    ///ServiceTicketFullDetailsRequires active-e Service Tickets Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ServiceTicketFullDetailsRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val RefNumber:String = null with get,set

        [<DataMember>]
        member val ChangedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

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