Northwind Web Services

QueryCustomers

AutoQuery

The following routes are available for this service:
All Verbs	/query/customers

import 'package:servicestack/servicestack.dart';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? skip;

    // @DataMember(Order=2)
    int? take;

    // @DataMember(Order=3)
    String? orderBy;

    // @DataMember(Order=4)
    String? orderByDesc;

    // @DataMember(Order=5)
    String? include;

    // @DataMember(Order=6)
    String? fields;

    // @DataMember(Order=7)
    Map<String,String?>? meta;

    QueryBase({this.skip,this.take,this.orderBy,this.orderByDesc,this.include,this.fields,this.meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        skip = json['skip'];
        take = json['take'];
        orderBy = json['orderBy'];
        orderByDesc = json['orderByDesc'];
        include = json['include'];
        fields = json['fields'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'skip': skip,
        'take': take,
        'orderBy': orderBy,
        'orderByDesc': orderByDesc,
        'include': include,
        'fields': fields,
        'meta': meta
    };

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

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

// @DataContract
class Customer implements IConvertible
{
    // @DataMember
    String? id;

    // @DataMember
    String? companyName;

    // @DataMember
    String? contactName;

    // @DataMember
    String? contactTitle;

    // @DataMember
    String? address;

    // @DataMember
    String? city;

    // @DataMember
    String? region;

    // @DataMember
    String? postalCode;

    // @DataMember
    String? country;

    // @DataMember
    String? phone;

    // @DataMember
    String? fax;

    Customer({this.id,this.companyName,this.contactName,this.contactTitle,this.address,this.city,this.region,this.postalCode,this.country,this.phone,this.fax});
    Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        companyName = json['companyName'];
        contactName = json['contactName'];
        contactTitle = json['contactTitle'];
        address = json['address'];
        city = json['city'];
        region = json['region'];
        postalCode = json['postalCode'];
        country = json['country'];
        phone = json['phone'];
        fax = json['fax'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'companyName': companyName,
        'contactName': contactName,
        'contactTitle': contactTitle,
        'address': address,
        'city': city,
        'region': region,
        'postalCode': postalCode,
        'country': country,
        'phone': phone,
        'fax': fax
    };

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

class QueryCustomers extends QueryDb<Customer> implements IConvertible
{
    List<String>? ids;
    String? countryStartsWith;

    QueryCustomers({this.ids,this.countryStartsWith});
    QueryCustomers.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @DataContract
class QueryResponse<Customer> implements IConvertible
{
    // @DataMember(Order=1)
    int? offset;

    // @DataMember(Order=2)
    int? total;

    // @DataMember(Order=3)
    List<Customer>? results;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    // @DataMember(Order=5)
    ResponseStatus? responseStatus;

    QueryResponse({this.offset,this.total,this.results,this.meta,this.responseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        offset = json['offset'];
        total = json['total'];
        results = JsonConverters.fromJson(json['results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

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

    getTypeName() => "QueryResponse<$Customer>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'northwind.netcore.io', types: <String, TypeInfo> {
    'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
    'QueryCustomers': TypeInfo(TypeOf.Class, create:() => QueryCustomers()),
    'List<Customer>': TypeInfo(TypeOf.Class, create:() => <Customer>[]),
    'QueryResponse<Customer>': TypeInfo(TypeOf.Class, create:() => QueryResponse<Customer>()),
});

Dart QueryCustomers 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 /query/customers HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/x-vcard
Content-Type: text/x-vcard
Content-Length: length

{"ids":["String"],"countryStartsWith":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/x-vcard
Content-Length: length

{"offset":0,"total":0,"results":[{"id":"String","companyName":"String","contactName":"String","contactTitle":"String","address":"String","city":"String","region":"String","postalCode":"String","country":"String","phone":"String","fax":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}