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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DependentAttribute
{
    // @DataMember
    public Attribute: string;

    // @DataMember
    public AttributeValue: string;

    public constructor(init?: Partial<DependentAttribute>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Base64Image
{
    // @DataMember
    public Data: string;

    // @DataMember
    public FileName: string;

    public constructor(init?: Partial<Base64Image>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DeliveryItem
{
    // @DataMember
    public Quantity: number;

    // @DataMember
    public Item: string;

    // @DataMember
    public Description: string;

    public constructor(init?: Partial<DeliveryItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DeliveryTicket
{
    // @DataMember
    public RefNumber: string;

    // @DataMember
    public Date: string;

    // @DataMember
    public AccountNumber: number;

    // @DataMember
    public Name: string;

    // @DataMember
    public Address: string;

    // @DataMember
    public Address2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public ZipCode: string;

    // @DataMember
    public Student: string;

    // @DataMember
    public Contact: string;

    // @DataMember
    public Delivered: boolean;

    // @DataMember
    public District: string;

    // @DataMember
    public School: string;

    // @DataMember
    public DeliveryEmployee: string;

    // @DataMember
    public TimeFrame: string;

    // @DataMember
    public CreatedDate: string;

    // @DataMember
    public DependentAttributes: DependentAttribute[];

    // @DataMember
    public TicketType: string;

    // @DataMember
    public HasImages: boolean;

    // @DataMember
    public HasSignature: boolean;

    // @DataMember
    public Base64Signature: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Images: Base64Image[];

    // @DataMember
    public DeliveryItems: DeliveryItem[];

    public constructor(init?: Partial<DeliveryTicket>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DeliveryTicketsResponse extends BaseResponse
{
    // @DataMember
    public Tickets: DeliveryTicket[];

    public constructor(init?: Partial<DeliveryTicketsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class DeliveryTicketItem
{
    // @DataMember
    public RefNumber: string;

    // @DataMember
    public Delivered: boolean;

    // @DataMember
    public Images: Base64Image[];

    // @DataMember
    public Base64Signature: string;

    // @DataMember
    public ImagesToDelete: string[];

    // @DataMember
    public Notes: string;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public Latitude: number;

    public constructor(init?: Partial<DeliveryTicketItem>) { (Object as any).assign(this, init); }
}

/** @description DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce. */
// @DataContract
export class DeliveryTicketsPostRequest extends BaseSecureRequest
{
    // @DataMember
    public DeliveryTickets: DeliveryTicketItem[];

    public constructor(init?: Partial<DeliveryTicketsPostRequest>) { super(init); (Object as any).assign(this, init); }
}

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