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
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

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

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

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    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)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    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) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

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

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken: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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}