Northwind Web Services

<back to all web services

GetOrders

Orders
The following routes are available for this service:
All Verbs/orders
All Verbs/orders/page/{Page}
All Verbs/customers/{CustomerId}/orders
import 'package:servicestack/servicestack.dart';

// @DataContract
class Order implements IConvertible
{
    // @DataMember
    int? id;

    // @DataMember
    String? customerId;

    // @DataMember
    int? employeeId;

    // @DataMember
    DateTime? orderDate;

    // @DataMember
    DateTime? requiredDate;

    // @DataMember
    DateTime? shippedDate;

    // @DataMember
    int? shipVia;

    // @DataMember
    double? freight;

    // @DataMember
    String? shipName;

    // @DataMember
    String? shipAddress;

    // @DataMember
    String? shipCity;

    // @DataMember
    String? shipRegion;

    // @DataMember
    String? shipPostalCode;

    // @DataMember
    String? shipCountry;

    Order({this.id,this.customerId,this.employeeId,this.orderDate,this.requiredDate,this.shippedDate,this.shipVia,this.freight,this.shipName,this.shipAddress,this.shipCity,this.shipRegion,this.shipPostalCode,this.shipCountry});
    Order.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        customerId = json['customerId'];
        employeeId = json['employeeId'];
        orderDate = JsonConverters.fromJson(json['orderDate'],'DateTime',context!);
        requiredDate = JsonConverters.fromJson(json['requiredDate'],'DateTime',context!);
        shippedDate = JsonConverters.fromJson(json['shippedDate'],'DateTime',context!);
        shipVia = json['shipVia'];
        freight = JsonConverters.toDouble(json['freight']);
        shipName = json['shipName'];
        shipAddress = json['shipAddress'];
        shipCity = json['shipCity'];
        shipRegion = json['shipRegion'];
        shipPostalCode = json['shipPostalCode'];
        shipCountry = json['shipCountry'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'customerId': customerId,
        'employeeId': employeeId,
        'orderDate': JsonConverters.toJson(orderDate,'DateTime',context!),
        'requiredDate': JsonConverters.toJson(requiredDate,'DateTime',context!),
        'shippedDate': JsonConverters.toJson(shippedDate,'DateTime',context!),
        'shipVia': shipVia,
        'freight': freight,
        'shipName': shipName,
        'shipAddress': shipAddress,
        'shipCity': shipCity,
        'shipRegion': shipRegion,
        'shipPostalCode': shipPostalCode,
        'shipCountry': shipCountry
    };

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

// @DataContract
class OrderDetail implements IConvertible
{
    // @DataMember
    int? orderId;

    // @DataMember
    int? productId;

    // @DataMember
    double? unitPrice;

    // @DataMember
    int? quantity;

    // @DataMember
    double? discount;

    OrderDetail({this.orderId,this.productId,this.unitPrice,this.quantity,this.discount});
    OrderDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        orderId = json['orderId'];
        productId = json['productId'];
        unitPrice = JsonConverters.toDouble(json['unitPrice']);
        quantity = json['quantity'];
        discount = JsonConverters.toDouble(json['discount']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'orderId': orderId,
        'productId': productId,
        'unitPrice': unitPrice,
        'quantity': quantity,
        'discount': discount
    };

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

// @DataContract
class CustomerOrder implements IConvertible
{
    // @DataMember
    Order? order;

    // @DataMember
    List<OrderDetail>? orderDetails;

    CustomerOrder({this.order,this.orderDetails});
    CustomerOrder.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        order = JsonConverters.fromJson(json['order'],'Order',context!);
        orderDetails = JsonConverters.fromJson(json['orderDetails'],'List<OrderDetail>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'order': JsonConverters.toJson(order,'Order',context!),
        'orderDetails': JsonConverters.toJson(orderDetails,'List<OrderDetail>',context!)
    };

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

// @DataContract
class OrdersResponse implements IConvertible
{
    // @DataMember
    List<CustomerOrder>? results;

    // @DataMember
    ResponseStatus? responseStatus;

    OrdersResponse({this.results,this.responseStatus});
    OrdersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        results = JsonConverters.fromJson(json['results'],'List<CustomerOrder>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'results': JsonConverters.toJson(results,'List<CustomerOrder>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

class GetOrders implements IGet, IConvertible
{
    int? page;
    String? customerId;

    GetOrders({this.page,this.customerId});
    GetOrders.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'page': page,
        'customerId': customerId
    };

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

TypeContext _ctx = TypeContext(library: 'northwind.netcore.io', types: <String, TypeInfo> {
    'Order': TypeInfo(TypeOf.Class, create:() => Order()),
    'OrderDetail': TypeInfo(TypeOf.Class, create:() => OrderDetail()),
    'CustomerOrder': TypeInfo(TypeOf.Class, create:() => CustomerOrder()),
    'List<OrderDetail>': TypeInfo(TypeOf.Class, create:() => <OrderDetail>[]),
    'OrdersResponse': TypeInfo(TypeOf.Class, create:() => OrdersResponse()),
    'List<CustomerOrder>': TypeInfo(TypeOf.Class, create:() => <CustomerOrder>[]),
    'GetOrders': TypeInfo(TypeOf.Class, create:() => GetOrders()),
});

Dart GetOrders DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/x-vcard
Content-Type: text/x-vcard
Content-Length: length

{"page":0,"customerId":"String"}
HTTP/1.1 200 OK
Content-Type: text/x-vcard
Content-Length: length

{"results":[{"order":{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","shipVia":0,"freight":0,"shipName":"String","shipAddress":"String","shipCity":"String","shipRegion":"String","shipPostalCode":"String","shipCountry":"String"},"orderDetails":[{"orderId":0,"productId":0,"unitPrice":0,"quantity":0,"discount":0}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}