Tax Filing Service

BatchRevokeOrders

RevokeOrdersSync

Represents a service request to revoke specified orders.

**Requires Authentication**
Required role:	Admin	Required permissions:	CanAccess, CanDelete

The following routes are available for this service:
DELETE	/sync/orders/batch

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Represents a service request to revoke specified orders.
*/
@Api(Description="Represents a service request to revoke specified orders.")
open class BatchRevokeOrders : BatchRevokeOrdersBase()
{
}

/**
* Specifies a base service to revoke specified orders.
*/
@Api(Description="Specifies a base service to revoke specified orders.")
open class BatchRevokeOrdersBase : PaginationBase(), IDelete
{
    /**
    * The collection of specified unique identifiers of the orders to delete.
    */
    @ApiMember(Description="The collection of specified unique identifiers of the orders to delete.")
    open var ids:ArrayList<Int> = ArrayList<Int>()
}

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

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

/**
* 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>()
{
}

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

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

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

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

    @DataMember(Order=5)
    open 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)
    open 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)
    open 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)
    open var accountId:Int? = null

    /**
    * A name to identify the order.
    */
    @ApiMember(Description="A name to identify the order.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    override 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.")
    open var serviceName:String? = null

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

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

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

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

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

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

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

    /**
    * The unit of measurement for the order.
    */
    @ApiMember(Description="The unit of measurement for the order.")
    open 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.")
    open 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.")
    open 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.")
    open var dataName:String? = null

    /**
    * The date of creation of the order.
    */
    @ApiMember(Description="The date of creation of the order.")
    open 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.")
    open 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.")
    open var isTest:Boolean? = null
}

Kotlin BatchRevokeOrders 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.

DELETE /sync/orders/batch 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
		}
	}
}