AIM Web Services

<back to all web services

DeliveryTicketsPostRequest

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

The following routes are available for this service:
POST/api/DeliveryTickets
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

    [<DataContract>]
    [<AllowNullLiteral>]
    type DependentAttribute() = 
        [<DataMember>]
        member val Attribute:String = null with get,set

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type Base64Image() = 
        [<DataMember>]
        member val Data:String = null with get,set

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeliveryTicket() = 
        [<DataMember>]
        member val RefNumber:String = null with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeliveryTicketsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Tickets:ResizeArray<DeliveryTicket> = new ResizeArray<DeliveryTicket>() 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

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeliveryTicketItem() = 
        [<DataMember>]
        member val RefNumber:String = null with get,set

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

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

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

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

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

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

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

    ///<summary>
    ///DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type DeliveryTicketsPostRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val DeliveryTickets:ResizeArray<DeliveryTicketItem> = new ResizeArray<DeliveryTicketItem>() with get,set

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

POST /api/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeliveryTicketsPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DeliveryTickets>
    <DeliveryTicketItem>
      <Base64Signature>String</Base64Signature>
      <Delivered>false</Delivered>
      <Images>
        <Base64Image>
          <Data>String</Data>
          <FileName>String</FileName>
        </Base64Image>
      </Images>
      <ImagesToDelete xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ImagesToDelete>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Notes>String</Notes>
      <RefNumber>String</RefNumber>
    </DeliveryTicketItem>
  </DeliveryTickets>
</DeliveryTicketsPostRequest>

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>