Tax Filing Service

<back to all web services

RevokeOrderAsync

RevokeOrdersAsync

Represents a service request to revoke an existing order in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanDelete
The following routes are available for this service:
DELETE/async/orders/{Id}
namespace PwC.Metering.Core.Domain.Concretes.Models

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Specifies a base service response class that contains a structured error information.
    ///</summary>
    [<Api(Description="Specifies a base service response class that contains a structured error information.")>]
    [<AllowNullLiteral>]
    type ServiceResponseBase() = 
        ///<summary>
        ///Data structure that holds error information from a service operation.
        ///</summary>
        [<ApiMember(Description="Data structure that holds error information from a service operation.")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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 service response that encapsulates an order data.
    ///</summary>
    [<Api(Description="Represents a service response that encapsulates an order data.")>]
    [<AllowNullLiteral>]
    type OrderResponse() = 
        inherit ServiceResponseBase()
        ///<summary>
        ///The order data of the response.
        ///</summary>
        [<ApiMember(Description="The order data of the response.")>]
        member val Order:Order = null with get,set

    ///<summary>
    ///Specifies a base service to revoke an existing order.
    ///</summary>
    [<Api(Description="Specifies a base service to revoke an existing order.")>]
    [<AllowNullLiteral>]
    type RevokeOrderBase() = 
        interface IDelete
        ///<summary>
        ///The unique identifier of the order.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the order.")>]
        member val Id:Int32 = new Int32() with get,set

    ///<summary>
    ///Represents a service request to revoke an existing order in an asynchronous operation.
    ///</summary>
    [<Api(Description="Represents a service request to revoke an existing order in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type RevokeOrderAsync() = 
        inherit RevokeOrderBase()

F# RevokeOrderAsync 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.

DELETE /async/orders/{Id} HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <Order xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <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>
  </Order>
</OrderResponse>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.