AIM Web Services

<back to all web services

DeliveryTicketsRequest

DeliveryTickets
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/DeliveryTickets
import Foundation
import ServiceStack

/**
* DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
public class DeliveryTicketsRequest : BaseSecureRequest
{
    // @DataMember
    public var dateFrom:Date?

    // @DataMember
    public var dateTo:Date?

    // @DataMember
    public var district:String

    // @DataMember
    public var school:String

    // @DataMember
    public var locationId:Int?

    /**
    * Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval", IsRequired=true, Name="TicketType", ParameterType="query")
    public var ticketType:String

    // @DataMember
    public var employeeLanId:String

    // @DataMember
    public var deliveryEmployeeLanId:String

    // @DataMember
    public var refNumber:String

    // @DataMember
    public var includeItems:Bool

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

    private enum CodingKeys : String, CodingKey {
        case dateFrom
        case dateTo
        case district
        case school
        case locationId
        case ticketType
        case employeeLanId
        case deliveryEmployeeLanId
        case refNumber
        case includeItems
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dateFrom = try container.decodeIfPresent(Date.self, forKey: .dateFrom)
        dateTo = try container.decodeIfPresent(Date.self, forKey: .dateTo)
        district = try container.decodeIfPresent(String.self, forKey: .district)
        school = try container.decodeIfPresent(String.self, forKey: .school)
        locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
        ticketType = try container.decodeIfPresent(String.self, forKey: .ticketType)
        employeeLanId = try container.decodeIfPresent(String.self, forKey: .employeeLanId)
        deliveryEmployeeLanId = try container.decodeIfPresent(String.self, forKey: .deliveryEmployeeLanId)
        refNumber = try container.decodeIfPresent(String.self, forKey: .refNumber)
        includeItems = try container.decodeIfPresent(Bool.self, forKey: .includeItems)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dateFrom != nil { try container.encode(dateFrom, forKey: .dateFrom) }
        if dateTo != nil { try container.encode(dateTo, forKey: .dateTo) }
        if district != nil { try container.encode(district, forKey: .district) }
        if school != nil { try container.encode(school, forKey: .school) }
        if locationId != nil { try container.encode(locationId, forKey: .locationId) }
        if ticketType != nil { try container.encode(ticketType, forKey: .ticketType) }
        if employeeLanId != nil { try container.encode(employeeLanId, forKey: .employeeLanId) }
        if deliveryEmployeeLanId != nil { try container.encode(deliveryEmployeeLanId, forKey: .deliveryEmployeeLanId) }
        if refNumber != nil { try container.encode(refNumber, forKey: .refNumber) }
        if includeItems != nil { try container.encode(includeItems, forKey: .includeItems) }
    }
}

// @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 DeliveryTicketsResponse : BaseResponse
{
    // @DataMember
    public var tickets:[DeliveryTicket] = []

    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([DeliveryTicket].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 DeliveryTicket : Codable
{
    // @DataMember
    public var refNumber:String

    // @DataMember
    public var date:Date

    // @DataMember
    public var accountNumber:Int

    // @DataMember
    public var name:String

    // @DataMember
    public var address:String

    // @DataMember
    public var address2:String

    // @DataMember
    public var city:String

    // @DataMember
    public var state:String

    // @DataMember
    public var zipCode:String

    // @DataMember
    public var student:String

    // @DataMember
    public var contact:String

    // @DataMember
    public var delivered:Bool

    // @DataMember
    public var district:String

    // @DataMember
    public var school:String

    // @DataMember
    public var deliveryEmployee:String

    // @DataMember
    public var timeFrame:String

    // @DataMember
    public var createdDate:Date

    // @DataMember
    public var dependentAttributes:[DependentAttribute] = []

    // @DataMember
    public var ticketType:String

    // @DataMember
    public var hasImages:Bool

    // @DataMember
    public var hasSignature:Bool

    // @DataMember
    public var base64Signature:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var images:[Base64Image] = []

    // @DataMember
    public var deliveryItems:[DeliveryItem] = []

    required public init(){}
}

// @DataContract
public class DependentAttribute : Codable
{
    // @DataMember
    public var attribute:String

    // @DataMember
    public var attributeValue:String

    required public init(){}
}

// @DataContract
public class Base64Image : Codable
{
    // @DataMember
    public var data:String

    // @DataMember
    public var fileName:String

    required public init(){}
}

// @DataContract
public class DeliveryItem : Codable
{
    // @DataMember
    public var quantity:Double

    // @DataMember
    public var item:String

    // @DataMember
    public var Description:String

    required public init(){}
}

Swift DeliveryTicketsRequest 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/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<DeliveryTicketsResponse 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>
    <DeliveryTicket>
      <AccountNumber>0</AccountNumber>
      <Address>String</Address>
      <Address2>String</Address2>
      <Base64Signature>String</Base64Signature>
      <City>String</City>
      <Contact>String</Contact>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Date>0001-01-01T00:00:00</Date>
      <Delivered>false</Delivered>
      <DeliveryEmployee>String</DeliveryEmployee>
      <DeliveryItems>
        <DeliveryItem>
          <Description>String</Description>
          <Item>String</Item>
          <Quantity>0</Quantity>
        </DeliveryItem>
      </DeliveryItems>
      <DependentAttributes>
        <DependentAttribute>
          <Attribute>String</Attribute>
          <AttributeValue>String</AttributeValue>
        </DependentAttribute>
      </DependentAttributes>
      <District>String</District>
      <HasImages>false</HasImages>
      <HasSignature>false</HasSignature>
      <Images>
        <Base64Image>
          <Data>String</Data>
          <FileName>String</FileName>
        </Base64Image>
      </Images>
      <Name>String</Name>
      <Notes>String</Notes>
      <RefNumber>String</RefNumber>
      <School>String</School>
      <State>String</State>
      <Student>String</Student>
      <TicketType>String</TicketType>
      <TimeFrame>String</TimeFrame>
      <ZipCode>String</ZipCode>
    </DeliveryTicket>
  </Tickets>
</DeliveryTicketsResponse>