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}

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.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.Requests

        '''<Summary>
        '''Represents a service request to retrieve an order.
        '''</Summary>
        <Api(Description:="Represents a service request to retrieve an order.")>
        Public Partial Class RetrieveOrder
            Inherits RetrieveOrderBase
            '''<Summary>
            '''The unique identifier of the order.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the order.")>
            Public Overridable Property Id As Integer
        End Class

        '''<Summary>
        '''Specifies a service request to retrieve an order.
        '''</Summary>
        <Api(Description:="Specifies a service request to retrieve an order.")>
        Public Partial Class RetrieveOrderBase
            Implements IGet
            '''<Summary>
            '''The unique identifier of the order.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the order.")>
            Public Overridable Property Id As Integer
        End Class
    End Namespace

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

        '''<Summary>
        '''Represents a service response that encapsulates an order data.
        '''</Summary>
        <Api(Description:="Represents a service response that encapsulates an order data.")>
        Public Partial Class OrderResponse
            Inherits ServiceResponseBase
            '''<Summary>
            '''The order data of the response.
            '''</Summary>
            <ApiMember(Description:="The order data of the response.")>
            Public Overridable Property Order As Order

            '''<Summary>
            '''Data structure that holds error information from a service operation.
            '''</Summary>
            <ApiMember(Description:="Data structure that holds error information from a service operation.")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

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

VB.NET RetrieveOrder DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.pwc.de 
Accept: application/json

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

{"order":{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}