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
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * 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")
    String? ApiKey;

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

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    String? Token;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    String? DeviceId;

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

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

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

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

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class DependentAttribute implements IConvertible
{
    // @DataMember
    String? Attribute;

    // @DataMember
    String? AttributeValue;

    DependentAttribute({this.Attribute,this.AttributeValue});
    DependentAttribute.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Attribute = json['Attribute'];
        AttributeValue = json['AttributeValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Attribute': Attribute,
        'AttributeValue': AttributeValue
    };

    getTypeName() => "DependentAttribute";
    TypeContext? context = _ctx;
}

// @DataContract
class Base64Image implements IConvertible
{
    // @DataMember
    String? Data;

    // @DataMember
    String? FileName;

    Base64Image({this.Data,this.FileName});
    Base64Image.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Data = json['Data'];
        FileName = json['FileName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Data': Data,
        'FileName': FileName
    };

    getTypeName() => "Base64Image";
    TypeContext? context = _ctx;
}

// @DataContract
class DeliveryItem implements IConvertible
{
    // @DataMember
    double? Quantity;

    // @DataMember
    String? Item;

    // @DataMember
    String? Description;

    DeliveryItem({this.Quantity,this.Item,this.Description});
    DeliveryItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Quantity = JsonConverters.toDouble(json['Quantity']);
        Item = json['Item'];
        Description = json['Description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Quantity': Quantity,
        'Item': Item,
        'Description': Description
    };

    getTypeName() => "DeliveryItem";
    TypeContext? context = _ctx;
}

// @DataContract
class DeliveryTicket implements IConvertible
{
    // @DataMember
    String? RefNumber;

    // @DataMember
    DateTime? Date;

    // @DataMember
    int? AccountNumber;

    // @DataMember
    String? Name;

    // @DataMember
    String? Address;

    // @DataMember
    String? Address2;

    // @DataMember
    String? City;

    // @DataMember
    String? State;

    // @DataMember
    String? ZipCode;

    // @DataMember
    String? Student;

    // @DataMember
    String? Contact;

    // @DataMember
    bool? Delivered;

    // @DataMember
    String? District;

    // @DataMember
    String? School;

    // @DataMember
    String? DeliveryEmployee;

    // @DataMember
    String? TimeFrame;

    // @DataMember
    DateTime? CreatedDate;

    // @DataMember
    List<DependentAttribute>? DependentAttributes;

    // @DataMember
    String? TicketType;

    // @DataMember
    bool? HasImages;

    // @DataMember
    bool? HasSignature;

    // @DataMember
    String? Base64Signature;

    // @DataMember
    String? Notes;

    // @DataMember
    List<Base64Image>? Images;

    // @DataMember
    List<DeliveryItem>? DeliveryItems;

    DeliveryTicket({this.RefNumber,this.Date,this.AccountNumber,this.Name,this.Address,this.Address2,this.City,this.State,this.ZipCode,this.Student,this.Contact,this.Delivered,this.District,this.School,this.DeliveryEmployee,this.TimeFrame,this.CreatedDate,this.DependentAttributes,this.TicketType,this.HasImages,this.HasSignature,this.Base64Signature,this.Notes,this.Images,this.DeliveryItems});
    DeliveryTicket.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RefNumber = json['RefNumber'];
        Date = JsonConverters.fromJson(json['Date'],'DateTime',context!);
        AccountNumber = json['AccountNumber'];
        Name = json['Name'];
        Address = json['Address'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        ZipCode = json['ZipCode'];
        Student = json['Student'];
        Contact = json['Contact'];
        Delivered = json['Delivered'];
        District = json['District'];
        School = json['School'];
        DeliveryEmployee = json['DeliveryEmployee'];
        TimeFrame = json['TimeFrame'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        DependentAttributes = JsonConverters.fromJson(json['DependentAttributes'],'List<DependentAttribute>',context!);
        TicketType = json['TicketType'];
        HasImages = json['HasImages'];
        HasSignature = json['HasSignature'];
        Base64Signature = json['Base64Signature'];
        Notes = json['Notes'];
        Images = JsonConverters.fromJson(json['Images'],'List<Base64Image>',context!);
        DeliveryItems = JsonConverters.fromJson(json['DeliveryItems'],'List<DeliveryItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RefNumber': RefNumber,
        'Date': JsonConverters.toJson(Date,'DateTime',context!),
        'AccountNumber': AccountNumber,
        'Name': Name,
        'Address': Address,
        'Address2': Address2,
        'City': City,
        'State': State,
        'ZipCode': ZipCode,
        'Student': Student,
        'Contact': Contact,
        'Delivered': Delivered,
        'District': District,
        'School': School,
        'DeliveryEmployee': DeliveryEmployee,
        'TimeFrame': TimeFrame,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'DependentAttributes': JsonConverters.toJson(DependentAttributes,'List<DependentAttribute>',context!),
        'TicketType': TicketType,
        'HasImages': HasImages,
        'HasSignature': HasSignature,
        'Base64Signature': Base64Signature,
        'Notes': Notes,
        'Images': JsonConverters.toJson(Images,'List<Base64Image>',context!),
        'DeliveryItems': JsonConverters.toJson(DeliveryItems,'List<DeliveryItem>',context!)
    };

    getTypeName() => "DeliveryTicket";
    TypeContext? context = _ctx;
}

// @DataContract
class DeliveryTicketsResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<DeliveryTicket>? Tickets;

    DeliveryTicketsResponse({this.Tickets});
    DeliveryTicketsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Tickets = JsonConverters.fromJson(json['Tickets'],'List<DeliveryTicket>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Tickets': JsonConverters.toJson(Tickets,'List<DeliveryTicket>',context!)
    });

    getTypeName() => "DeliveryTicketsResponse";
    TypeContext? context = _ctx;
}

/**
* DeliveryTicketsRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
class DeliveryTicketsRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    DateTime? DateFrom;

    // @DataMember
    DateTime? DateTo;

    // @DataMember
    String? District;

    // @DataMember
    String? School;

    // @DataMember
    int? LocationId;

    /**
    * Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Type of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval", IsRequired=true, Name="TicketType", ParameterType="query")
    String? TicketType;

    // @DataMember
    String? EmployeeLanId;

    // @DataMember
    String? DeliveryEmployeeLanId;

    // @DataMember
    String? RefNumber;

    // @DataMember
    bool? IncludeItems;

    DeliveryTicketsRequest({this.DateFrom,this.DateTo,this.District,this.School,this.LocationId,this.TicketType,this.EmployeeLanId,this.DeliveryEmployeeLanId,this.RefNumber,this.IncludeItems});
    DeliveryTicketsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        DateFrom = JsonConverters.fromJson(json['DateFrom'],'DateTime',context!);
        DateTo = JsonConverters.fromJson(json['DateTo'],'DateTime',context!);
        District = json['District'];
        School = json['School'];
        LocationId = json['LocationId'];
        TicketType = json['TicketType'];
        EmployeeLanId = json['EmployeeLanId'];
        DeliveryEmployeeLanId = json['DeliveryEmployeeLanId'];
        RefNumber = json['RefNumber'];
        IncludeItems = json['IncludeItems'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'DateFrom': JsonConverters.toJson(DateFrom,'DateTime',context!),
        'DateTo': JsonConverters.toJson(DateTo,'DateTime',context!),
        'District': District,
        'School': School,
        'LocationId': LocationId,
        'TicketType': TicketType,
        'EmployeeLanId': EmployeeLanId,
        'DeliveryEmployeeLanId': DeliveryEmployeeLanId,
        'RefNumber': RefNumber,
        'IncludeItems': IncludeItems
    });

    getTypeName() => "DeliveryTicketsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'DependentAttribute': TypeInfo(TypeOf.Class, create:() => DependentAttribute()),
    'Base64Image': TypeInfo(TypeOf.Class, create:() => Base64Image()),
    'DeliveryItem': TypeInfo(TypeOf.Class, create:() => DeliveryItem()),
    'DeliveryTicket': TypeInfo(TypeOf.Class, create:() => DeliveryTicket()),
    'List<DependentAttribute>': TypeInfo(TypeOf.Class, create:() => <DependentAttribute>[]),
    'List<Base64Image>': TypeInfo(TypeOf.Class, create:() => <Base64Image>[]),
    'List<DeliveryItem>': TypeInfo(TypeOf.Class, create:() => <DeliveryItem>[]),
    'DeliveryTicketsResponse': TypeInfo(TypeOf.Class, create:() => DeliveryTicketsResponse()),
    'List<DeliveryTicket>': TypeInfo(TypeOf.Class, create:() => <DeliveryTicket>[]),
    'DeliveryTicketsRequest': TypeInfo(TypeOf.Class, create:() => DeliveryTicketsRequest()),
});

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