Tax Filing Service

<back to all web services

SearchOrders

SearchOrdersSync

Represents a service request from a standard user to search for orders.

Requires Authentication
Required role:AllowAnyUserRequired permission:CanAccess
The following routes are available for this service:
GET/sync/orders/search
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* The number of query results to skip.
*/
// @Api(Description="The number of query results to skip.")
abstract class PaginationBase implements IPaginate
{
    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    PaginationBase({this.skip,this.take});
    PaginationBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'skip': skip,
        'take': take
    };

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

/**
* Represents a specific time interval, within which, an action was carried out.
*/
enum PeriodMode
{
    Today,
    Yesterday,
    LastWeek,
    Last30Days,
    Last90Days,
    Last180Days,
}

/**
* Specifies a service request from a standard user to search for orders.
*/
// @Api(Description="Specifies a service request from a standard user to search for orders.")
abstract class SearchOrdersBase extends PaginationBase implements IGet
{
    /**
    * The user name of the account.
    */
    // @ApiMember(Description="The user name of the account.")
    String? userName;

    /**
    * The name of the order.
    */
    // @ApiMember(Description="The name of the order.")
    String? name;

    /**
    * Search by using the name of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
    String? nameStartsWith;

    /**
    * Search by using the name of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
    String? nameEndsWith;

    /**
    * Search by using the name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    String? nameContains;

    /**
    * Search by using the name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    String? serviceName;

    /**
    * Search by using the service name of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
    String? serviceNameStartsWith;

    /**
    * Search by using the service name of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
    String? serviceNameEndsWith;

    /**
    * Search by using the service name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
    String? serviceNameContains;

    /**
    * Search for orders placed before a certain date and time. The specified date is included in the search.
    */
    // @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    DateTime? before;

    /**
    * Search for orders placed after a certain date and time. The specified date is included in the search.
    */
    // @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    DateTime? after;

    /**
    * Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    DateTime? periodStartDate;

    /**
    * Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    DateTime? periodEndDate;

    /**
    * Search for orders placed within the last 180 days. Today is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    PeriodMode? periodMode;

    /**
    * Was the order request successful?
    */
    // @ApiMember(Description="Was the order request successful?")
    bool? orderRequestSucceeded;

    /**
    * The unit of measurement for the order.
    */
    // @ApiMember(Description="The unit of measurement for the order.")
    String? unitOfMeasurement;

    /**
    * Search by using the unit of measurement of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    String? unitOfMeasurementStartsWith;

    /**
    * Search by using the unit of measurement of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    String? unitOfMeasurementEndsWith;

    /**
    * Search by using the unit of measurement of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    String? unitOfMeasurementContains;

    /**
    * The type of process, for which the order is charged.
    */
    // @ApiMember(Description="The type of process, for which the order is charged.")
    String? processType;

    /**
    * Search by using the process type of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    String? processTypeStartsWith;

    /**
    * Search by using the process type of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    String? processTypeEndsWith;

    /**
    * Search by using the process type of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    String? processTypeContains;

    /**
    * The type of data, for which the order is charged.
    */
    // @ApiMember(Description="The type of data, for which the order is charged.")
    String? dataType;

    /**
    * Search by using the type of data, for which the order is charged that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    String? dataTypeStartsWith;

    /**
    * Search by using the type of data, for which the order is charged that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    String? dataTypeEndsWith;

    /**
    * Search by using the type of data, for which the order is charged that contains the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    String? dataTypeContains;

    /**
    * The name of the data, for which the order is charged.
    */
    // @ApiMember(Description="The name of the data, for which the order is charged.")
    String? dataName;

    /**
    * Search by using the name of data, for which the order is charged that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    String? dataNameStartsWith;

    /**
    * Search by using the name of data, for which the order is charged that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    String? dataNameEndsWith;

    /**
    * Search by using the name of data, for which the order is charged that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    String? dataNameContains;

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    SearchOrdersBase({this.userName,this.name,this.nameStartsWith,this.nameEndsWith,this.nameContains,this.serviceName,this.serviceNameStartsWith,this.serviceNameEndsWith,this.serviceNameContains,this.before,this.after,this.periodStartDate,this.periodEndDate,this.periodMode,this.orderRequestSucceeded,this.unitOfMeasurement,this.unitOfMeasurementStartsWith,this.unitOfMeasurementEndsWith,this.unitOfMeasurementContains,this.processType,this.processTypeStartsWith,this.processTypeEndsWith,this.processTypeContains,this.dataType,this.dataTypeStartsWith,this.dataTypeEndsWith,this.dataTypeContains,this.dataName,this.dataNameStartsWith,this.dataNameEndsWith,this.dataNameContains,this.skip,this.take});
    SearchOrdersBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        userName = json['userName'];
        name = json['name'];
        nameStartsWith = json['nameStartsWith'];
        nameEndsWith = json['nameEndsWith'];
        nameContains = json['nameContains'];
        serviceName = json['serviceName'];
        serviceNameStartsWith = json['serviceNameStartsWith'];
        serviceNameEndsWith = json['serviceNameEndsWith'];
        serviceNameContains = json['serviceNameContains'];
        before = JsonConverters.fromJson(json['before'],'DateTime',context!);
        after = JsonConverters.fromJson(json['after'],'DateTime',context!);
        periodStartDate = JsonConverters.fromJson(json['periodStartDate'],'DateTime',context!);
        periodEndDate = JsonConverters.fromJson(json['periodEndDate'],'DateTime',context!);
        periodMode = JsonConverters.fromJson(json['periodMode'],'PeriodMode',context!);
        orderRequestSucceeded = json['orderRequestSucceeded'];
        unitOfMeasurement = json['unitOfMeasurement'];
        unitOfMeasurementStartsWith = json['unitOfMeasurementStartsWith'];
        unitOfMeasurementEndsWith = json['unitOfMeasurementEndsWith'];
        unitOfMeasurementContains = json['unitOfMeasurementContains'];
        processType = json['processType'];
        processTypeStartsWith = json['processTypeStartsWith'];
        processTypeEndsWith = json['processTypeEndsWith'];
        processTypeContains = json['processTypeContains'];
        dataType = json['dataType'];
        dataTypeStartsWith = json['dataTypeStartsWith'];
        dataTypeEndsWith = json['dataTypeEndsWith'];
        dataTypeContains = json['dataTypeContains'];
        dataName = json['dataName'];
        dataNameStartsWith = json['dataNameStartsWith'];
        dataNameEndsWith = json['dataNameEndsWith'];
        dataNameContains = json['dataNameContains'];
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'userName': userName,
        'name': name,
        'nameStartsWith': nameStartsWith,
        'nameEndsWith': nameEndsWith,
        'nameContains': nameContains,
        'serviceName': serviceName,
        'serviceNameStartsWith': serviceNameStartsWith,
        'serviceNameEndsWith': serviceNameEndsWith,
        'serviceNameContains': serviceNameContains,
        'before': JsonConverters.toJson(before,'DateTime',context!),
        'after': JsonConverters.toJson(after,'DateTime',context!),
        'periodStartDate': JsonConverters.toJson(periodStartDate,'DateTime',context!),
        'periodEndDate': JsonConverters.toJson(periodEndDate,'DateTime',context!),
        'periodMode': JsonConverters.toJson(periodMode,'PeriodMode',context!),
        'orderRequestSucceeded': orderRequestSucceeded,
        'unitOfMeasurement': unitOfMeasurement,
        'unitOfMeasurementStartsWith': unitOfMeasurementStartsWith,
        'unitOfMeasurementEndsWith': unitOfMeasurementEndsWith,
        'unitOfMeasurementContains': unitOfMeasurementContains,
        'processType': processType,
        'processTypeStartsWith': processTypeStartsWith,
        'processTypeEndsWith': processTypeEndsWith,
        'processTypeContains': processTypeContains,
        'dataType': dataType,
        'dataTypeStartsWith': dataTypeStartsWith,
        'dataTypeEndsWith': dataTypeEndsWith,
        'dataTypeContains': dataTypeContains,
        'dataName': dataName,
        'dataNameStartsWith': dataNameStartsWith,
        'dataNameEndsWith': dataNameEndsWith,
        'dataNameContains': dataNameContains,
        'skip': skip,
        'take': take
    });

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

/**
* Represents a commission to consume services.
*/
// @Api(Description="Represents a commission to consume services.")
class Order implements IHasName, IConvertible
{
    /**
    * The unique identifier of the order.
    */
    // @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    int? id;

    /**
    * The unique identifier of the product, for which the order is made.
    */
    // @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
    int? productId;

    /**
    * The unique identifier of the user account, who placed the order.
    */
    // @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
    int? accountId;

    /**
    * A name to identify the order.
    */
    // @ApiMember(Description="A name to identify the order.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    String? name;

    /**
    * The name of the service, for which the order was made.
    */
    // @ApiMember(Description="The name of the service, for which the order was made.")
    String? serviceName;

    /**
    * The time stamp at which the order was initiated.
    */
    // @ApiMember(Description="The time stamp at which the order was initiated.")
    DateTime? requestTimestamp;

    /**
    * The time stamp at which the order was completed.
    */
    // @ApiMember(Description="The time stamp at which the order was completed.")
    DateTime? responseTimestamp;

    /**
    * The URI from which the order was initiated.
    */
    // @ApiMember(Description="The URI from which the order was initiated.")
    String? requestUri;

    /**
    * The HTTP method of the order request.
    */
    // @ApiMember(Description="The HTTP method of the order request.")
    String? requestHttpMethod;

    /**
    * The duration of the order request.
    */
    // @ApiMember(Description="The duration of the order request.")
    Duration? requestDuration;

    /**
    * The HTTP status code of the order request.
    */
    // @ApiMember(Description="The HTTP status code of the order request.")
    HttpStatusCode? responseStatusCode;

    /**
    * The IP address of client, who placed the order.
    */
    // @ApiMember(Description="The IP address of client, who placed the order.")
    String? clientIPAddress;

    /**
    * The unit of measurement for the order.
    */
    // @ApiMember(Description="The unit of measurement for the order.")
    String? unitOfMeasurement;

    /**
    * The type of process, for which the order is charged.
    */
    // @ApiMember(Description="The type of process, for which the order is charged.")
    String? processType;

    /**
    * The type of data, for which the order is charged.
    */
    // @ApiMember(Description="The type of data, for which the order is charged.")
    String? dataType;

    /**
    * The name of the data, for which the order is charged.
    */
    // @ApiMember(Description="The name of the data, for which the order is charged.")
    String? dataName;

    /**
    * The date of creation of the order.
    */
    // @ApiMember(Description="The date of creation of the order.")
    DateTime? creationDate;

    /**
    * The final date to retain the order in the records. After this date, the order is expunged from the records.
    */
    // @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
    DateTime? expiryDate;

    /**
    * Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
    */
    // @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
    bool? isTest;

    Order({this.id,this.productId,this.accountId,this.name,this.serviceName,this.requestTimestamp,this.responseTimestamp,this.requestUri,this.requestHttpMethod,this.requestDuration,this.responseStatusCode,this.clientIPAddress,this.unitOfMeasurement,this.processType,this.dataType,this.dataName,this.creationDate,this.expiryDate,this.isTest});
    Order.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        productId = json['productId'];
        accountId = json['accountId'];
        name = json['name'];
        serviceName = json['serviceName'];
        requestTimestamp = JsonConverters.fromJson(json['requestTimestamp'],'DateTime',context!);
        responseTimestamp = JsonConverters.fromJson(json['responseTimestamp'],'DateTime',context!);
        requestUri = json['requestUri'];
        requestHttpMethod = json['requestHttpMethod'];
        requestDuration = JsonConverters.fromJson(json['requestDuration'],'Duration',context!);
        responseStatusCode = JsonConverters.fromJson(json['responseStatusCode'],'HttpStatusCode',context!);
        clientIPAddress = json['clientIPAddress'];
        unitOfMeasurement = json['unitOfMeasurement'];
        processType = json['processType'];
        dataType = json['dataType'];
        dataName = json['dataName'];
        creationDate = JsonConverters.fromJson(json['creationDate'],'DateTime',context!);
        expiryDate = JsonConverters.fromJson(json['expiryDate'],'DateTime',context!);
        isTest = json['isTest'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'productId': productId,
        'accountId': accountId,
        'name': name,
        'serviceName': serviceName,
        'requestTimestamp': JsonConverters.toJson(requestTimestamp,'DateTime',context!),
        'responseTimestamp': JsonConverters.toJson(responseTimestamp,'DateTime',context!),
        'requestUri': requestUri,
        'requestHttpMethod': requestHttpMethod,
        'requestDuration': JsonConverters.toJson(requestDuration,'Duration',context!),
        'responseStatusCode': JsonConverters.toJson(responseStatusCode,'HttpStatusCode',context!),
        'clientIPAddress': clientIPAddress,
        'unitOfMeasurement': unitOfMeasurement,
        'processType': processType,
        'dataType': dataType,
        'dataName': dataName,
        'creationDate': JsonConverters.toJson(creationDate,'DateTime',context!),
        'expiryDate': JsonConverters.toJson(expiryDate,'DateTime',context!),
        'isTest': isTest
    };

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

/**
* Represents a query response that contains a structured error information and encapsulates customers.
*/
// @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
class OrderQueryResponse extends QueryResponse<Order> implements IConvertible
{
    // @DataMember(Order=1)
    int? offset;

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

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

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

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

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

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

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

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

/**
* Represents a service request from a standard user to search for orders.
*/
// @Api(Description="Represents a service request from a standard user to search for orders.")
class SearchOrders extends SearchOrdersBase implements IConvertible
{
    /**
    * The user name of the account.
    */
    // @ApiMember(Description="The user name of the account.")
    String? userName;

    /**
    * The name of the order.
    */
    // @ApiMember(Description="The name of the order.")
    String? name;

    /**
    * Search by using the name of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
    String? nameStartsWith;

    /**
    * Search by using the name of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
    String? nameEndsWith;

    /**
    * Search by using the name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    String? nameContains;

    /**
    * Search by using the name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    String? serviceName;

    /**
    * Search by using the service name of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
    String? serviceNameStartsWith;

    /**
    * Search by using the service name of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
    String? serviceNameEndsWith;

    /**
    * Search by using the service name of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
    String? serviceNameContains;

    /**
    * Search for orders placed before a certain date and time. The specified date is included in the search.
    */
    // @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    DateTime? before;

    /**
    * Search for orders placed after a certain date and time. The specified date is included in the search.
    */
    // @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    DateTime? after;

    /**
    * Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    DateTime? periodStartDate;

    /**
    * Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    DateTime? periodEndDate;

    /**
    * Search for orders placed within the last 180 days. Today is included in the search.
    */
    // @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    PeriodMode? periodMode;

    /**
    * Was the order request successful?
    */
    // @ApiMember(Description="Was the order request successful?")
    bool? orderRequestSucceeded;

    /**
    * The unit of measurement for the order.
    */
    // @ApiMember(Description="The unit of measurement for the order.")
    String? unitOfMeasurement;

    /**
    * Search by using the unit of measurement of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    String? unitOfMeasurementStartsWith;

    /**
    * Search by using the unit of measurement of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    String? unitOfMeasurementEndsWith;

    /**
    * Search by using the unit of measurement of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    String? unitOfMeasurementContains;

    /**
    * The type of process, for which the order is charged.
    */
    // @ApiMember(Description="The type of process, for which the order is charged.")
    String? processType;

    /**
    * Search by using the process type of the order that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    String? processTypeStartsWith;

    /**
    * Search by using the process type of the order that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    String? processTypeEndsWith;

    /**
    * Search by using the process type of the order that contains the specified value.
    */
    // @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    String? processTypeContains;

    /**
    * The type of data, for which the order is charged.
    */
    // @ApiMember(Description="The type of data, for which the order is charged.")
    String? dataType;

    /**
    * Search by using the type of data, for which the order is charged that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    String? dataTypeStartsWith;

    /**
    * Search by using the type of data, for which the order is charged that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    String? dataTypeEndsWith;

    /**
    * Search by using the type of data, for which the order is charged that contains the specified value.
    */
    // @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    String? dataTypeContains;

    /**
    * The name of the data, for which the order is charged.
    */
    // @ApiMember(Description="The name of the data, for which the order is charged.")
    String? dataName;

    /**
    * Search by using the name of data, for which the order is charged that starts with the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    String? dataNameStartsWith;

    /**
    * Search by using the name of data, for which the order is charged that ends with the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    String? dataNameEndsWith;

    /**
    * Search by using the name of data, for which the order is charged that contains the specified value.
    */
    // @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    String? dataNameContains;

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    SearchOrders({this.userName,this.name,this.nameStartsWith,this.nameEndsWith,this.nameContains,this.serviceName,this.serviceNameStartsWith,this.serviceNameEndsWith,this.serviceNameContains,this.before,this.after,this.periodStartDate,this.periodEndDate,this.periodMode,this.orderRequestSucceeded,this.unitOfMeasurement,this.unitOfMeasurementStartsWith,this.unitOfMeasurementEndsWith,this.unitOfMeasurementContains,this.processType,this.processTypeStartsWith,this.processTypeEndsWith,this.processTypeContains,this.dataType,this.dataTypeStartsWith,this.dataTypeEndsWith,this.dataTypeContains,this.dataName,this.dataNameStartsWith,this.dataNameEndsWith,this.dataNameContains,this.skip,this.take});
    SearchOrders.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        userName = json['userName'];
        name = json['name'];
        nameStartsWith = json['nameStartsWith'];
        nameEndsWith = json['nameEndsWith'];
        nameContains = json['nameContains'];
        serviceName = json['serviceName'];
        serviceNameStartsWith = json['serviceNameStartsWith'];
        serviceNameEndsWith = json['serviceNameEndsWith'];
        serviceNameContains = json['serviceNameContains'];
        before = JsonConverters.fromJson(json['before'],'DateTime',context!);
        after = JsonConverters.fromJson(json['after'],'DateTime',context!);
        periodStartDate = JsonConverters.fromJson(json['periodStartDate'],'DateTime',context!);
        periodEndDate = JsonConverters.fromJson(json['periodEndDate'],'DateTime',context!);
        periodMode = JsonConverters.fromJson(json['periodMode'],'PeriodMode',context!);
        orderRequestSucceeded = json['orderRequestSucceeded'];
        unitOfMeasurement = json['unitOfMeasurement'];
        unitOfMeasurementStartsWith = json['unitOfMeasurementStartsWith'];
        unitOfMeasurementEndsWith = json['unitOfMeasurementEndsWith'];
        unitOfMeasurementContains = json['unitOfMeasurementContains'];
        processType = json['processType'];
        processTypeStartsWith = json['processTypeStartsWith'];
        processTypeEndsWith = json['processTypeEndsWith'];
        processTypeContains = json['processTypeContains'];
        dataType = json['dataType'];
        dataTypeStartsWith = json['dataTypeStartsWith'];
        dataTypeEndsWith = json['dataTypeEndsWith'];
        dataTypeContains = json['dataTypeContains'];
        dataName = json['dataName'];
        dataNameStartsWith = json['dataNameStartsWith'];
        dataNameEndsWith = json['dataNameEndsWith'];
        dataNameContains = json['dataNameContains'];
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'userName': userName,
        'name': name,
        'nameStartsWith': nameStartsWith,
        'nameEndsWith': nameEndsWith,
        'nameContains': nameContains,
        'serviceName': serviceName,
        'serviceNameStartsWith': serviceNameStartsWith,
        'serviceNameEndsWith': serviceNameEndsWith,
        'serviceNameContains': serviceNameContains,
        'before': JsonConverters.toJson(before,'DateTime',context!),
        'after': JsonConverters.toJson(after,'DateTime',context!),
        'periodStartDate': JsonConverters.toJson(periodStartDate,'DateTime',context!),
        'periodEndDate': JsonConverters.toJson(periodEndDate,'DateTime',context!),
        'periodMode': JsonConverters.toJson(periodMode,'PeriodMode',context!),
        'orderRequestSucceeded': orderRequestSucceeded,
        'unitOfMeasurement': unitOfMeasurement,
        'unitOfMeasurementStartsWith': unitOfMeasurementStartsWith,
        'unitOfMeasurementEndsWith': unitOfMeasurementEndsWith,
        'unitOfMeasurementContains': unitOfMeasurementContains,
        'processType': processType,
        'processTypeStartsWith': processTypeStartsWith,
        'processTypeEndsWith': processTypeEndsWith,
        'processTypeContains': processTypeContains,
        'dataType': dataType,
        'dataTypeStartsWith': dataTypeStartsWith,
        'dataTypeEndsWith': dataTypeEndsWith,
        'dataTypeContains': dataTypeContains,
        'dataName': dataName,
        'dataNameStartsWith': dataNameStartsWith,
        'dataNameEndsWith': dataNameEndsWith,
        'dataNameContains': dataNameContains,
        'skip': skip,
        'take': take
    });

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

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

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

    // @DataMember(Order=3)
    List<T>? 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<T>',context!),
        'meta': meta,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'PaginationBase': TypeInfo(TypeOf.AbstractClass),
    'PeriodMode': TypeInfo(TypeOf.Enum, enumValues:PeriodMode.values),
    'SearchOrdersBase': TypeInfo(TypeOf.AbstractClass),
    'Order': TypeInfo(TypeOf.Class, create:() => Order()),
    'HttpStatusCode': TypeInfo(TypeOf.Class, create:() => HttpStatusCode()),
    'OrderQueryResponse': TypeInfo(TypeOf.Class, create:() => OrderQueryResponse()),
    'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
    'SearchOrders': TypeInfo(TypeOf.Class, create:() => SearchOrders()),
});

Dart SearchOrders 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.

GET /sync/orders/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <Offset xmlns="http://schemas.servicestack.net/types">0</Offset>
  <Total xmlns="http://schemas.servicestack.net/types">0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types">
    <d2p1:Order>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:DataName>String</d2p1:DataName>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsTest>false</d2p1:IsTest>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProcessType>String</d2p1:ProcessType>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:RequestDuration>PT0S</d2p1:RequestDuration>
      <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod>
      <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp>
      <d2p1:RequestUri>String</d2p1:RequestUri>
      <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode>
      <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp>
      <d2p1:ServiceName>String</d2p1:ServiceName>
      <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement>
    </d2p1:Order>
  </Results>
  <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>
  <ResponseStatus xmlns="http://schemas.servicestack.net/types">
    <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>
</OrderQueryResponse>