Tax Filing Service

<back to all web services

BatchRevokeOrdersAsync

RevokeOrdersAsync

Represents a service request to revoke specified orders in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanDelete
The following routes are available for this service:
DELETE/async/orders/batch
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Services.Contracts.Helpers
Imports PwC.Metering.Core.Services.Contracts.Responses
Imports PwC.Metering.Core.Domain.Concretes.Models

Namespace Global

    Namespace PwC.Metering.Core.Domain.Concretes.Models

        '''<Summary>
        '''Represents a commission to consume services.
        '''</Summary>
        <Api(Description:="Represents a commission to consume services.")>
        Public Partial Class Order
            Implements IHasName
            '''<Summary>
            '''The unique identifier of the order.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the order.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<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)>
            Public Overridable Property ProductId As Integer

            '''<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)>
            Public Overridable Property AccountId As Integer

            '''<Summary>
            '''A name to identify the order.
            '''</Summary>
            <ApiMember(Description:="A name to identify the order.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String

            '''<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.")>
            Public Overridable Property ServiceName As String

            '''<Summary>
            '''The time stamp at which the order was initiated.
            '''</Summary>
            <ApiMember(Description:="The time stamp at which the order was initiated.")>
            Public Overridable Property RequestTimestamp As Nullable(Of Date)

            '''<Summary>
            '''The time stamp at which the order was completed.
            '''</Summary>
            <ApiMember(Description:="The time stamp at which the order was completed.")>
            Public Overridable Property ResponseTimestamp As Nullable(Of Date)

            '''<Summary>
            '''The URI from which the order was initiated.
            '''</Summary>
            <ApiMember(Description:="The URI from which the order was initiated.")>
            Public Overridable Property RequestUri As String

            '''<Summary>
            '''The HTTP method of the order request.
            '''</Summary>
            <ApiMember(Description:="The HTTP method of the order request.")>
            Public Overridable Property RequestHttpMethod As String

            '''<Summary>
            '''The duration of the order request.
            '''</Summary>
            <ApiMember(Description:="The duration of the order request.")>
            Public Overridable Property RequestDuration As Nullable(Of TimeSpan)

            '''<Summary>
            '''The HTTP status code of the order request.
            '''</Summary>
            <ApiMember(Description:="The HTTP status code of the order request.")>
            Public Overridable Property ResponseStatusCode As HttpStatusCode

            '''<Summary>
            '''The IP address of client, who placed the order.
            '''</Summary>
            <ApiMember(Description:="The IP address of client, who placed the order.")>
            Public Overridable Property ClientIPAddress As String

            '''<Summary>
            '''The unit of measurement for the order.
            '''</Summary>
            <ApiMember(Description:="The unit of measurement for the order.")>
            Public Overridable Property UnitOfMeasurement As String

            '''<Summary>
            '''The type of process, for which the order is charged.
            '''</Summary>
            <ApiMember(Description:="The type of process, for which the order is charged.")>
            Public Overridable Property ProcessType As String

            '''<Summary>
            '''The type of data, for which the order is charged.
            '''</Summary>
            <ApiMember(Description:="The type of data, for which the order is charged.")>
            Public Overridable Property DataType As String

            '''<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.")>
            Public Overridable Property DataName As String

            '''<Summary>
            '''The date of creation of the order.
            '''</Summary>
            <ApiMember(Description:="The date of creation of the order.")>
            Public Overridable Property CreationDate As Date

            '''<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.")>
            Public Overridable Property ExpiryDate As Nullable(Of Date)

            '''<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.")>
            Public Overridable Property IsTest As Boolean
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Helpers

        '''<Summary>
        '''The number of query results to skip.
        '''</Summary>
        <Api(Description:="The number of query results to skip.")>
        Public Partial Class PaginationBase
            Implements IPaginate
            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Requests

        '''<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.")>
        Public Partial Class BatchRevokeOrdersAsync
            Inherits BatchRevokeOrdersBase
            Public Sub New()
                Ids = New List(Of Integer)
            End Sub

            '''<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.")>
            Public Overridable Property Ids As List(Of Integer)

            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class

        '''<Summary>
        '''Specifies a base service to revoke specified orders.
        '''</Summary>
        <Api(Description:="Specifies a base service to revoke specified orders.")>
        Public Partial Class BatchRevokeOrdersBase
            Inherits PaginationBase
            Implements IDelete
            Public Sub New()
                Ids = New List(Of Integer)
            End Sub

            '''<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.")>
            Public Overridable Property Ids As List(Of Integer)

            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Responses

        '''<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.")>
        Public Partial Class OrderQueryResponse
            Inherits QueryResponse(Of Order)
            Public Sub New()
                Results = New List(Of Order)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Order)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET BatchRevokeOrdersAsync 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/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>
© 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.