Tax Filing Service

<back to all web services

AdminSearchOrdersAsync

SearchOrdersAsync

Represents a service request from an admin user to search for orders in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/admin/orders/search
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a service request from an admin user to search for orders in an asynchronous operation.
*/
@Api(Description="Represents a service request from an admin user to search for orders in an asynchronous operation.")
open class AdminSearchOrdersAsync : AdminSearchOrdersBase()
{
    /**
    * The user name of the account.
    */
    @ApiMember(Description="The user name of the account.")
    var userName:String? = null

    /**
    * The unique identifier of the order.
    */
    @ApiMember(Description="The unique identifier of the order.")
    var orderId:Int? = null

    /**
    * 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.")
    var productId:Int? = null

    /**
    * The unique identifier of the user account, who made the order.
    */
    @ApiMember(Description="The unique identifier of the user account, who made the order.")
    var accountId:Int? = null

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

    /**
    * 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.")
    var nameStartsWith:String? = null

    /**
    * 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.")
    var nameEndsWith:String? = null

    /**
    * 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.")
    var nameContains:String? = null

    /**
    * 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.")
    var serviceName:String? = null

    /**
    * 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.")
    var serviceNameStartsWith:String? = null

    /**
    * 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.")
    var serviceNameEndsWith:String? = null

    /**
    * 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.")
    var serviceNameContains:String? = null

    /**
    * 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.")
    var before:Date? = null

    /**
    * 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.")
    var after:Date? = null

    /**
    * 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.")
    var periodStartDate:Date? = null

    /**
    * 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.")
    var periodEndDate:Date? = null

    /**
    * 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.")
    var periodMode:PeriodMode? = null

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

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

    /**
    * Was the order request successful?
    */
    @ApiMember(Description="Was the order request successful?")
    var orderRequestSucceeded:Boolean? = null

    /**
    * The initial IP address of client, who made the order.
    */
    @ApiMember(Description="The initial IP address of client, who made the order.")
    var clientIPAddress:String? = null

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

    /**
    * 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.")
    var unitOfMeasurementStartsWith:String? = null

    /**
    * 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.")
    var unitOfMeasurementEndsWith:String? = null

    /**
    * 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.")
    var unitOfMeasurementContains:String? = null

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

    /**
    * 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.")
    var processTypeStartsWith:String? = null

    /**
    * 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.")
    var processTypeEndsWith:String? = null

    /**
    * 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.")
    var processTypeContains:String? = null

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

    /**
    * 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.")
    var dataTypeStartsWith:String? = null

    /**
    * 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.")
    var dataTypeEndsWith:String? = null

    /**
    * 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.")
    var dataTypeContains:String? = null

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

    /**
    * 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.")
    var dataNameStartsWith:String? = null

    /**
    * 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.")
    var dataNameEndsWith:String? = null

    /**
    * 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.")
    var dataNameContains:String? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* Specifies a service request from an admin user to search for orders.
*/
@Api(Description="Specifies a service request from an admin user to search for orders.")
open class AdminSearchOrdersBase : PaginationBase(), IGet
{
    /**
    * The user name of the account.
    */
    @ApiMember(Description="The user name of the account.")
    var userName:String? = null

    /**
    * The unique identifier of the order.
    */
    @ApiMember(Description="The unique identifier of the order.")
    var orderId:Int? = null

    /**
    * 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.")
    var productId:Int? = null

    /**
    * The unique identifier of the user account, who made the order.
    */
    @ApiMember(Description="The unique identifier of the user account, who made the order.")
    var accountId:Int? = null

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

    /**
    * 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.")
    var nameStartsWith:String? = null

    /**
    * 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.")
    var nameEndsWith:String? = null

    /**
    * 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.")
    var nameContains:String? = null

    /**
    * 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.")
    var serviceName:String? = null

    /**
    * 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.")
    var serviceNameStartsWith:String? = null

    /**
    * 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.")
    var serviceNameEndsWith:String? = null

    /**
    * 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.")
    var serviceNameContains:String? = null

    /**
    * 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.")
    var before:Date? = null

    /**
    * 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.")
    var after:Date? = null

    /**
    * 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.")
    var periodStartDate:Date? = null

    /**
    * 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.")
    var periodEndDate:Date? = null

    /**
    * 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.")
    var periodMode:PeriodMode? = null

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

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

    /**
    * Was the order request successful?
    */
    @ApiMember(Description="Was the order request successful?")
    var orderRequestSucceeded:Boolean? = null

    /**
    * The initial IP address of client, who made the order.
    */
    @ApiMember(Description="The initial IP address of client, who made the order.")
    var clientIPAddress:String? = null

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

    /**
    * 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.")
    var unitOfMeasurementStartsWith:String? = null

    /**
    * 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.")
    var unitOfMeasurementEndsWith:String? = null

    /**
    * 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.")
    var unitOfMeasurementContains:String? = null

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

    /**
    * 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.")
    var processTypeStartsWith:String? = null

    /**
    * 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.")
    var processTypeEndsWith:String? = null

    /**
    * 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.")
    var processTypeContains:String? = null

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

    /**
    * 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.")
    var dataTypeStartsWith:String? = null

    /**
    * 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.")
    var dataTypeEndsWith:String? = null

    /**
    * 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.")
    var dataTypeContains:String? = null

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

    /**
    * 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.")
    var dataNameStartsWith:String? = null

    /**
    * 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.")
    var dataNameEndsWith:String? = null

    /**
    * 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.")
    var dataNameContains:String? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
open class PaginationBase : IPaginate
{
    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

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

/**
* 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.")
open class OrderQueryResponse : QueryResponse<Order>()
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<Order> = ArrayList<Order>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
open class Order : IHasName
{
    /**
    * The unique identifier of the order.
    */
    @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    var id:Int? = null

    /**
    * 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)
    var productId:Int? = null

    /**
    * 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)
    var accountId:Int? = null

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

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

    /**
    * The time stamp at which the order was initiated.
    */
    @ApiMember(Description="The time stamp at which the order was initiated.")
    var requestTimestamp:Date? = null

    /**
    * The time stamp at which the order was completed.
    */
    @ApiMember(Description="The time stamp at which the order was completed.")
    var responseTimestamp:Date? = null

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

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

    /**
    * The duration of the order request.
    */
    @ApiMember(Description="The duration of the order request.")
    var requestDuration:TimeSpan? = null

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

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

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

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

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

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

    /**
    * The date of creation of the order.
    */
    @ApiMember(Description="The date of creation of the order.")
    var creationDate:Date? = null

    /**
    * 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.")
    var expiryDate:Date? = null

    /**
    * 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.")
    var isTest:Boolean? = null
}

Kotlin AdminSearchOrdersAsync DTOs

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

HTTP + JSV

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

GET /async/admin/orders/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			productId: 0,
			accountId: 0,
			name: String,
			serviceName: String,
			requestTimestamp: 0001-01-01,
			responseTimestamp: 0001-01-01,
			requestUri: String,
			requestHttpMethod: String,
			requestDuration: PT0S,
			responseStatusCode: Continue,
			clientIPAddress: String,
			unitOfMeasurement: String,
			processType: String,
			dataType: String,
			dataName: String,
			creationDate: 0001-01-01,
			expiryDate: 0001-01-01,
			isTest: False
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}