Tax Filing Service

RetrieveOrder

RetrieveOrdersSync

Represents a service request to retrieve an order.

**Requires Authentication**
Required role:	Admin	Required permission:	CanAccess

The following routes are available for this service:
GET	/sync/orders/{Id}

**RetrieveOrder** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No	The unique identifier of the order.

**RetrieveOrderBase** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The unique identifier of the order.

**OrderResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Order	form	Order	No	The order data of the response.
ResponseStatus	form	ResponseStatus	No	Data structure that holds error information from a service operation.

**ServiceResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	Data structure that holds error information from a service operation.

**Order** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	Yes	The unique identifier of the order.
ProductId	form	int	Yes	The unique identifier of the product, for which the order is made.
AccountId	form	int	Yes	The unique identifier of the user account, who placed the order.
Name	form	string	Yes	A name to identify the order.
ServiceName	form	string	No	The name of the service, for which the order was made.
RequestTimestamp	form	DateTime?	No	The time stamp at which the order was initiated.
ResponseTimestamp	form	DateTime?	No	The time stamp at which the order was completed.
RequestUri	form	string	No	The URI from which the order was initiated.
RequestHttpMethod	form	string	No	The HTTP method of the order request.
RequestDuration	form	TimeSpan?	No	The duration of the order request.
ResponseStatusCode	form	HttpStatusCode	No	The HTTP status code of the order request.
ClientIPAddress	form	string	No	The IP address of client, who placed the order.
UnitOfMeasurement	form	string	No	The unit of measurement for the order.
ProcessType	form	string	No	The type of process, for which the order is charged.
DataType	form	string	No	The type of data, for which the order is charged.
DataName	form	string	No	The name of the data, for which the order is charged.
CreationDate	form	DateTime	No	The date of creation of the order.
ExpiryDate	form	DateTime?	No	The final date to retain the order in the records. After this date, the order is expunged from the records.
IsTest	form	bool	No	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.

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 /sync/orders/{Id} HTTP/1.1 
Host: taxfiling.staging.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>