Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanDelete |
| DELETE | /async/orders/batch |
|---|
namespace PwC.Metering.Core.Domain.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Represents a commission to consume services.
///</summary>
[<Api(Description="Represents a commission to consume services.")>]
[<AllowNullLiteral>]
type Order() =
///<summary>
///The unique identifier of the order.
///</summary>
[<ApiMember(Description="The unique identifier of the order.", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The unique identifier of the product, for which the order is made.
///</summary>
[<ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)>]
member val ProductId:Int32 = new Int32() with get,set
///<summary>
///The unique identifier of the user account, who placed the order.
///</summary>
[<ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)>]
member val AccountId:Int32 = new Int32() with get,set
///<summary>
///A name to identify the order.
///</summary>
[<ApiMember(Description="A name to identify the order.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Name:String = null with get,set
///<summary>
///The name of the service, for which the order was made.
///</summary>
[<ApiMember(Description="The name of the service, for which the order was made.")>]
member val ServiceName:String = null with get,set
///<summary>
///The time stamp at which the order was initiated.
///</summary>
[<ApiMember(Description="The time stamp at which the order was initiated.")>]
member val RequestTimestamp:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The time stamp at which the order was completed.
///</summary>
[<ApiMember(Description="The time stamp at which the order was completed.")>]
member val ResponseTimestamp:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The URI from which the order was initiated.
///</summary>
[<ApiMember(Description="The URI from which the order was initiated.")>]
member val RequestUri:String = null with get,set
///<summary>
///The HTTP method of the order request.
///</summary>
[<ApiMember(Description="The HTTP method of the order request.")>]
member val RequestHttpMethod:String = null with get,set
///<summary>
///The duration of the order request.
///</summary>
[<ApiMember(Description="The duration of the order request.")>]
member val RequestDuration:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
///<summary>
///The HTTP status code of the order request.
///</summary>
[<ApiMember(Description="The HTTP status code of the order request.")>]
member val ResponseStatusCode:HttpStatusCode = new HttpStatusCode() with get,set
///<summary>
///The IP address of client, who placed the order.
///</summary>
[<ApiMember(Description="The IP address of client, who placed the order.")>]
member val ClientIPAddress:String = null with get,set
///<summary>
///The unit of measurement for the order.
///</summary>
[<ApiMember(Description="The unit of measurement for the order.")>]
member val UnitOfMeasurement:String = null with get,set
///<summary>
///The type of process, for which the order is charged.
///</summary>
[<ApiMember(Description="The type of process, for which the order is charged.")>]
member val ProcessType:String = null with get,set
///<summary>
///The type of data, for which the order is charged.
///</summary>
[<ApiMember(Description="The type of data, for which the order is charged.")>]
member val DataType:String = null with get,set
///<summary>
///The name of the data, for which the order is charged.
///</summary>
[<ApiMember(Description="The name of the data, for which the order is charged.")>]
member val DataName:String = null with get,set
///<summary>
///The date of creation of the order.
///</summary>
[<ApiMember(Description="The date of creation of the order.")>]
member val CreationDate:DateTime = new DateTime() with get,set
///<summary>
///The final date to retain the order in the records. After this date, the order is expunged from the records.
///</summary>
[<ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")>]
member val ExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///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.
///</summary>
[<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.")>]
member val IsTest:Boolean = new Boolean() with get,set
///<summary>
///Represents a query response that contains a structured error information and encapsulates customers.
///</summary>
[<Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")>]
[<AllowNullLiteral>]
type OrderQueryResponse() =
inherit QueryResponse<Order>()
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<Order> = new ResizeArray<Order>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<Api(Description="The number of query results to skip.")>]
[<AllowNullLiteral>]
type PaginationBase() =
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specifies a base service to revoke specified orders.
///</summary>
[<Api(Description="Specifies a base service to revoke specified orders.")>]
[<AllowNullLiteral>]
type BatchRevokeOrdersBase() =
inherit PaginationBase()
interface IDelete
///<summary>
///The collection of specified unique identifiers of the orders to delete.
///</summary>
[<ApiMember(Description="The collection of specified unique identifiers of the orders to delete.")>]
member val Ids:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Represents a service request to revoke specified orders in an asynchronous operation.
///</summary>
[<Api(Description="Represents a service request to revoke specified orders in an asynchronous operation.")>]
[<AllowNullLiteral>]
type BatchRevokeOrdersAsync() =
inherit BatchRevokeOrdersBase()
///<summary>
///The collection of specified unique identifiers of the orders to delete.
///</summary>
[<ApiMember(Description="The collection of specified unique identifiers of the orders to delete.")>]
member val Ids:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<T> = new ResizeArray<T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# BatchRevokeOrdersAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /async/orders/batch 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>