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
import Foundation
import ServiceStack

/**
* ServiceTicketFullDetailsRequires active-e Service Tickets Service
*/
// @DataContract
public class ServiceTicketFullDetailsRequest : BaseSecureRequest
{
    // @DataMember
    public var acct:Int?

    // @DataMember
    public var refNumber:String

    // @DataMember
    public var changedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case acct
        case refNumber
        case changedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        refNumber = try container.decodeIfPresent(String.self, forKey: .refNumber)
        changedDate = try container.decodeIfPresent(Date.self, forKey: .changedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if refNumber != nil { try container.encode(refNumber, forKey: .refNumber) }
        if changedDate != nil { try container.encode(changedDate, forKey: .changedDate) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public var token:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public var apiKey:String

    /**
    * The OAuthToken token return by AeServices30
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public var oAuthToken:String

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * An identifier for your integration
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){}
}

// @DataContract
public class ServiceTicketFullDetailsResponse : BaseResponse
{
    // @DataMember
    public var tickets:[TicketInfo] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case tickets
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        tickets = try container.decodeIfPresent([TicketInfo].self, forKey: .tickets) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if tickets.count > 0 { try container.encode(tickets, forKey: .tickets) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class TicketInfo : Codable
{
    // @DataMember
    public var terms:Int

    // @DataMember
    public var poNumber:String

    // @DataMember
    public var returnAuthorizationNumber:String

    // @DataMember
    public var status:String

    // @DataMember
    public var approvedAmount:Double

    // @DataMember
    public var totalDue:Double

    // @DataMember
    public var subtotal:Double

    // @DataMember
    public var tax1:Double

    // @DataMember
    public var tax2:Double

    // @DataMember
    public var approvedDate:Date

    // @DataMember
    public var billedDate:Date

    // @DataMember
    public var contact:String

    // @DataMember
    public var category:Int

    // @DataMember
    public var services:[ServiceInfo] = []

    // @DataMember
    public var categoryDescription:String

    // @DataMember
    public var subCategory:Int

    // @DataMember
    public var subCategoryDescription:String

    // @DataMember
    public var item:String

    // @DataMember
    public var itemDescription:String

    // @DataMember
    public var manufacturer:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var timestamp:Date

    // @DataMember
    public var soldToCustomerAcct:Int

    // @DataMember
    public var billToCustomerAcct:Int

    // @DataMember
    public var model:String

    // @DataMember
    public var stLoc:String

    // @DataMember
    public var taxLoc:String

    // @DataMember
    public var refNumber:String

    // @DataMember
    public var masterNumber:String

    // @DataMember
    public var invoiced:Bool

    // @DataMember
    public var deposits:[DepositInfo] = []

    // @DataMember
    public var soldToCustomerName:String

    // @DataMember
    public var billToCustomerName:String

    // @DataMember
    public var shipToName:String

    // @DataMember
    public var shipToId:Int?

    required public init(){}
}

public class ServiceInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var parts:[PartInfo] = []

    // @DataMember
    public var Description:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var rate:Double

    // @DataMember
    public var discount:Double

    // @DataMember
    public var total:Double

    // @DataMember
    public var time:Double

    // @DataMember
    public var completed:Bool

    // @DataMember
    public var completedDate:Date

    // @DataMember
    public var technician:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var category:Int

    // @DataMember
    public var categoryDescription:String

    // @DataMember
    public var timerActive:Bool

    // @DataMember
    public var timerStartTime:Date?

    required public init(){}
}

public class PartInfo : Codable
{
    // @DataMember
    public var Description:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var price:Double

    // @DataMember
    public var discount:Double

    // @DataMember
    public var total:Double

    // @DataMember
    public var notes:String

    // @DataMember
    public var category:Int

    // @DataMember
    public var categoryDescription:String

    // @DataMember
    public var sku:String

    required public init(){}
}

public class DepositInfo : Codable
{
    // @DataMember
    public var originalAmount:Double

    // @DataMember
    public var amount:Double

    // @DataMember
    public var refNumber:String

    required public init(){}
}

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