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
// @ts-nocheck

// @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;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

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

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token?: 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"DeliveryTickets":[{"RefNumber":"String","Delivered":false,"Images":[{"Data":"String","FileName":"String"}],"Base64Signature":"String","ImagesToDelete":["String"],"Notes":"String","Longitude":0,"Latitude":0}],"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"Tickets":[{"RefNumber":"String","AccountNumber":0,"Name":"String","Address":"String","Address2":"String","City":"String","State":"String","ZipCode":"String","Student":"String","Contact":"String","Delivered":false,"District":"String","School":"String","DeliveryEmployee":"String","TimeFrame":"String","DependentAttributes":[{"Attribute":"String","AttributeValue":"String"}],"TicketType":"String","HasImages":false,"HasSignature":false,"Base64Signature":"String","Notes":"String","Images":[{"Data":"String","FileName":"String"}],"DeliveryItems":[{"Quantity":0,"Item":"String","Description":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}