#Script Pages

<back to all web services

QueryCustomers

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

class Order implements IConvertible
{
    int? orderId;
    String? customerId;
    DateTime? orderDate;
    double? total;

    Order({this.orderId,this.customerId,this.orderDate,this.total});
    Order.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        orderId = json['orderId'];
        customerId = json['customerId'];
        orderDate = JsonConverters.fromJson(json['orderDate'],'DateTime',context!);
        total = JsonConverters.toDouble(json['total']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'orderId': orderId,
        'customerId': customerId,
        'orderDate': JsonConverters.toJson(orderDate,'DateTime',context!),
        'total': total
    };

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

class Customer implements IConvertible
{
    String? customerId;
    String? companyName;
    String? address;
    String? city;
    String? region;
    String? postalCode;
    String? country;
    String? phone;
    String? fax;
    List<Order>? orders;

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

    fromMap(Map<String, dynamic> json) {
        customerId = json['customerId'];
        companyName = json['companyName'];
        address = json['address'];
        city = json['city'];
        region = json['region'];
        postalCode = json['postalCode'];
        country = json['country'];
        phone = json['phone'];
        fax = json['fax'];
        orders = JsonConverters.fromJson(json['orders'],'List<Order>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'customerId': customerId,
        'companyName': companyName,
        'address': address,
        'city': city,
        'region': region,
        'postalCode': postalCode,
        'country': country,
        'phone': phone,
        'fax': fax,
        'orders': JsonConverters.toJson(orders,'List<Order>',context!)
    };

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

class QueryCustomers extends QueryDb<Customer> implements IConvertible
{
    String? customerId;
    String? companyNameContains;
    List<String>? countryIn;

    QueryCustomers({this.customerId,this.companyNameContains,this.countryIn});
    QueryCustomers.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    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: 'sharpscript.net', types: <String, TypeInfo> {
    'Order': TypeInfo(TypeOf.Class, create:() => Order()),
    'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
    'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
    '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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <CompanyNameContains>String</CompanyNameContains>
  <CountryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryIn>
  <CustomerId>String</CustomerId>
</QueryCustomers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomerA703xr44 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharpScript">
    <d2p1:Customer>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:Orders>
        <d2p1:Order>
          <d2p1:CustomerId>String</d2p1:CustomerId>
          <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
          <d2p1:OrderId>0</d2p1:OrderId>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Order>
      </d2p1:Orders>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:Customer>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCustomerA703xr44>