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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class DependentAttribute {
    /** @param {{Attribute?:string,AttributeValue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Attribute;
    /** @type {string} */
    AttributeValue;
}
export class Base64Image {
    /** @param {{Data?:string,FileName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Data;
    /** @type {string} */
    FileName;
}
export class DeliveryItem {
    /** @param {{Quantity?:number,Item?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Quantity;
    /** @type {string} */
    Item;
    /** @type {string} */
    Description;
}
export class DeliveryTicket {
    /** @param {{RefNumber?:string,Date?:string,AccountNumber?:number,Name?:string,Address?:string,Address2?:string,City?:string,State?:string,ZipCode?:string,Student?:string,Contact?:string,Delivered?:boolean,District?:string,School?:string,DeliveryEmployee?:string,TimeFrame?:string,CreatedDate?:string,DependentAttributes?:DependentAttribute[],TicketType?:string,HasImages?:boolean,HasSignature?:boolean,Base64Signature?:string,Notes?:string,Images?:Base64Image[],DeliveryItems?:DeliveryItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
    /** @type {string} */
    Date;
    /** @type {number} */
    AccountNumber;
    /** @type {string} */
    Name;
    /** @type {string} */
    Address;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    ZipCode;
    /** @type {string} */
    Student;
    /** @type {string} */
    Contact;
    /** @type {boolean} */
    Delivered;
    /** @type {string} */
    District;
    /** @type {string} */
    School;
    /** @type {string} */
    DeliveryEmployee;
    /** @type {string} */
    TimeFrame;
    /** @type {string} */
    CreatedDate;
    /** @type {DependentAttribute[]} */
    DependentAttributes;
    /** @type {string} */
    TicketType;
    /** @type {boolean} */
    HasImages;
    /** @type {boolean} */
    HasSignature;
    /** @type {string} */
    Base64Signature;
    /** @type {string} */
    Notes;
    /** @type {Base64Image[]} */
    Images;
    /** @type {DeliveryItem[]} */
    DeliveryItems;
}
export class DeliveryTicketsResponse extends BaseResponse {
    /** @param {{Tickets?:DeliveryTicket[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {DeliveryTicket[]} */
    Tickets;
}
export class DeliveryTicketsRequest extends BaseSecureRequest {
    /** @param {{DateFrom?:string,DateTo?:string,District?:string,School?:string,LocationId?:number,TicketType?:string,EmployeeLanId?:string,DeliveryEmployeeLanId?:string,RefNumber?:string,IncludeItems?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    DateFrom;
    /** @type {?string} */
    DateTo;
    /** @type {string} */
    District;
    /** @type {string} */
    School;
    /** @type {?number} */
    LocationId;
    /**
     * @type {string}
     * @description Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval */
    TicketType;
    /** @type {string} */
    EmployeeLanId;
    /** @type {string} */
    DeliveryEmployeeLanId;
    /** @type {string} */
    RefNumber;
    /** @type {boolean} */
    IncludeItems;
}

JavaScript DeliveryTicketsRequest 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.

GET /api/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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"}}