Tax Filing Service

<back to all web services

RetrieveOrderAsync

RetrieveOrdersAsync

Represents a service request to retrieve an order in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/orders/{Id}
import Foundation
import ServiceStack

/**
* Represents a service request to retrieve an order in an asynchronous operation.
*/
// @Api(Description="Represents a service request to retrieve an order in an asynchronous operation.")
public class RetrieveOrderAsync : RetrieveOrderBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* Specifies a service request to retrieve an order.
*/
// @Api(Description="Specifies a service request to retrieve an order.")
public class RetrieveOrderBase : IGet, Codable
{
    /**
    * The unique identifier of the order.
    */
    // @ApiMember(Description="The unique identifier of the order.")
    public var id:Int

    required public init(){}
}

/**
* Represents a service response that encapsulates an order data.
*/
// @Api(Description="Represents a service response that encapsulates an order data.")
public class OrderResponse : ServiceResponseBase
{
    /**
    * The order data of the response.
    */
    // @ApiMember(Description="The order data of the response.")
    public var order:Order

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case order
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        order = try container.decodeIfPresent(Order.self, forKey: .order)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if order != nil { try container.encode(order, forKey: .order) }
    }
}

/**
* Specifies a base service response class that contains a structured error information.
*/
// @Api(Description="Specifies a base service response class that contains a structured error information.")
public class ServiceResponseBase : Codable
{
    /**
    * Data structure that holds error information from a service operation.
    */
    // @ApiMember(Description="Data structure that holds error information from a service operation.")
    public var responseStatus:ResponseStatus

    required public init(){}
}

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

    /**
    * 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)
    public var productId:Int

    /**
    * 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)
    public var accountId:Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
    * 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.")
    public var isTest:Bool

    required public init(){}
}

Swift RetrieveOrderAsync 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.

GET /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.