AIM 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

**DeliveryTicketsPostRequest** Parameters:
Name	Parameter	Data Type	Required	Description
DeliveryTickets	body	List<DeliveryTicketItem>	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	Header	string	No	The Login Token return by the Security API. Required for secured calls.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	Header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	Header	string	Yes	The OAuthToken token return by AeServices30
DeviceId	Header	string	No	The Device ID of the Mobile Device. Not used for non-mobile devices.
AppId	Header	string	Yes	An identifier for your integration

**DeliveryTicketItem** Parameters:
Name	Parameter	Data Type	Required
RefNumber	form	string	No
Delivered	form	bool	No
Images	form	List<Base64Image>	No
Base64Signature	form	string	No
ImagesToDelete	form	List<string>	No
Notes	form	string	No
Longitude	form	decimal	No
Latitude	form	decimal	No

**Base64Image** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	string	No
FileName	form	string	No

**DeliveryTicketsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Tickets	form	List<DeliveryTicket>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**DeliveryTicket** Parameters:
Name	Parameter	Data Type	Required
RefNumber	form	string	No
Date	form	DateTime	No
AccountNumber	form	int	No
Name	form	string	No
Address	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
ZipCode	form	string	No
Student	form	string	No
Contact	form	string	No
Delivered	form	bool	No
District	form	string	No
School	form	string	No
DeliveryEmployee	form	string	No
TimeFrame	form	string	No
CreatedDate	form	DateTime	No
DependentAttributes	form	List<DependentAttribute>	No
TicketType	form	string	No
HasImages	form	bool	No
HasSignature	form	bool	No
Base64Signature	form	string	No
Notes	form	string	No
Images	form	List<Base64Image>	No
DeliveryItems	form	List<DeliveryItem>	No

**DependentAttribute** Parameters:
Name	Parameter	Data Type	Required	Description
Attribute	form	string	No
AttributeValue	form	string	No

**DeliveryItem** Parameters:
Name	Parameter	Data Type	Required
Quantity	form	decimal	No
Item	form	string	No
Description	form	string	No

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>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <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>

AIM Web Services

DeliveryTicketsPostRequest

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

HTTP + XML

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