Tax Filing Service

<back to all web services

RetrieveAllOrdersAsync

RetrieveOrdersAsync

Represents a service request to retrieve all orders in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/orders
namespace PwC.Metering.Core.Domain.Concretes.Models

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

    ///<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 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.")>]
    [<AllowNullLiteral>]
    type OrderQueryResponse() = 
        inherit QueryResponse<Order>()
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<Order> = new ResizeArray<Order>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///The number of query results to skip.
    ///</summary>
    [<Api(Description="The number of query results to skip.")>]
    [<AllowNullLiteral>]
    type PaginationBase() = 
        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [<ApiMember(Description="The number of query results to skip.")>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [<ApiMember(Description="The number of query results to include.")>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

    ///<summary>
    ///Specifies a service to retrieve all orders.
    ///</summary>
    [<Api(Description="Specifies a service to retrieve all orders.")>]
    [<AllowNullLiteral>]
    type RetrieveAllOrdersBase() = 
        inherit PaginationBase()
        interface IGet
        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [<ApiMember(Description="The number of query results to skip.")>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [<ApiMember(Description="The number of query results to include.")>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

    ///<summary>
    ///Represents a service request to retrieve all orders in an asynchronous operation.
    ///</summary>
    [<Api(Description="Represents a service request to retrieve all orders in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type RetrieveAllOrdersAsync() = 
        inherit RetrieveAllOrdersBase()
        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [<ApiMember(Description="The number of query results to skip.")>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [<ApiMember(Description="The number of query results to include.")>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<T> = new ResizeArray<T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# RetrieveAllOrdersAsync DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /async/orders HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"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}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}
© 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.