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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
@DataContract
open class DeliveryTicketsRequest : BaseSecureRequest()
{
    @DataMember
    var DateFrom:Date? = null

    @DataMember
    var DateTo:Date? = null

    @DataMember
    var District:String? = null

    @DataMember
    var School:String? = null

    @DataMember
    var LocationId:Long? = null

    /**
    * 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")
    var TicketType:String? = null

    @DataMember
    var EmployeeLanId:String? = null

    @DataMember
    var DeliveryEmployeeLanId:String? = null

    @DataMember
    var RefNumber:String? = null

    @DataMember
    var IncludeItems:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

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

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

@DataContract
open class BaseRequest
{
    /**
    * 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class DeliveryTicketsResponse : BaseResponse()
{
    @DataMember
    var Tickets:ArrayList<DeliveryTicket> = ArrayList<DeliveryTicket>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class DeliveryTicket
{
    @DataMember
    var RefNumber:String? = null

    @DataMember
    var Date:Date? = null

    @DataMember
    var AccountNumber:Int? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Address:String? = null

    @DataMember
    var Address2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var ZipCode:String? = null

    @DataMember
    var Student:String? = null

    @DataMember
    var Contact:String? = null

    @DataMember
    var Delivered:Boolean? = null

    @DataMember
    var District:String? = null

    @DataMember
    var School:String? = null

    @DataMember
    var DeliveryEmployee:String? = null

    @DataMember
    var TimeFrame:String? = null

    @DataMember
    var CreatedDate:Date? = null

    @DataMember
    var DependentAttributes:ArrayList<DependentAttribute> = ArrayList<DependentAttribute>()

    @DataMember
    var TicketType:String? = null

    @DataMember
    var HasImages:Boolean? = null

    @DataMember
    var HasSignature:Boolean? = null

    @DataMember
    var Base64Signature:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Images:ArrayList<Base64Image> = ArrayList<Base64Image>()

    @DataMember
    var DeliveryItems:ArrayList<DeliveryItem> = ArrayList<DeliveryItem>()
}

@DataContract
open class DependentAttribute
{
    @DataMember
    var Attribute:String? = null

    @DataMember
    var AttributeValue:String? = null
}

@DataContract
open class Base64Image
{
    @DataMember
    var Data:String? = null

    @DataMember
    var FileName:String? = null
}

@DataContract
open class DeliveryItem
{
    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var Item:String? = null

    @DataMember
    var Description:String? = null
}

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