Tax Filing Service
| Required role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /async/orders/search |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Metering.Core.Services.Contracts.Requests;
using PwC.Metering.Core.Services.Contracts.Helpers;
using PwC.Metering.Core.Services.Contracts.Responses;
using PwC.Metering.Core.Domain.Concretes.Models;
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
: IHasName
{
///<summary>
///The unique identifier of the order.
///</summary>
[ApiMember(Description="The unique identifier of the order.", IsRequired=true)]
public virtual int Id { 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)]
public virtual int ProductId { 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)]
public virtual int AccountId { get; set; }
///<summary>
///A name to identify the order.
///</summary>
[ApiMember(Description="A name to identify the order.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Name { 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.")]
public virtual string ServiceName { get; set; }
///<summary>
///The time stamp at which the order was initiated.
///</summary>
[ApiMember(Description="The time stamp at which the order was initiated.")]
public virtual DateTime? RequestTimestamp { get; set; }
///<summary>
///The time stamp at which the order was completed.
///</summary>
[ApiMember(Description="The time stamp at which the order was completed.")]
public virtual DateTime? ResponseTimestamp { get; set; }
///<summary>
///The URI from which the order was initiated.
///</summary>
[ApiMember(Description="The URI from which the order was initiated.")]
public virtual string RequestUri { get; set; }
///<summary>
///The HTTP method of the order request.
///</summary>
[ApiMember(Description="The HTTP method of the order request.")]
public virtual string RequestHttpMethod { get; set; }
///<summary>
///The duration of the order request.
///</summary>
[ApiMember(Description="The duration of the order request.")]
public virtual TimeSpan? RequestDuration { get; set; }
///<summary>
///The HTTP status code of the order request.
///</summary>
[ApiMember(Description="The HTTP status code of the order request.")]
public virtual HttpStatusCode ResponseStatusCode { get; set; }
///<summary>
///The IP address of client, who placed the order.
///</summary>
[ApiMember(Description="The IP address of client, who placed the order.")]
public virtual string ClientIPAddress { get; set; }
///<summary>
///The unit of measurement for the order.
///</summary>
[ApiMember(Description="The unit of measurement for the order.")]
public virtual string UnitOfMeasurement { 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.")]
public virtual string ProcessType { 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.")]
public virtual string DataType { 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.")]
public virtual string DataName { get; set; }
///<summary>
///The date of creation of the order.
///</summary>
[ApiMember(Description="The date of creation of the order.")]
public virtual DateTime CreationDate { 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.")]
public virtual DateTime? ExpiryDate { 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.")]
public virtual bool IsTest { get; set; }
}
}
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
: IPaginate
{
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
///<summary>
///Represents a specific time interval, within which, an action was carried out.
///</summary>
public enum PeriodMode
{
Today,
Yesterday,
LastWeek,
Last30Days,
Last90Days,
Last180Days,
}
}
namespace PwC.Metering.Core.Services.Contracts.Requests
{
///<summary>
///Represents a service request from a standard user to search for orders in an asynchronous operation.
///</summary>
[Api(Description="Represents a service request from a standard user to search for orders in an asynchronous operation.")]
public partial class SearchOrdersAsync
: SearchOrdersBase
{
///<summary>
///The user name of the account.
///</summary>
[ApiMember(Description="The user name of the account.")]
public virtual string UserName { get; set; }
///<summary>
///The name of the order.
///</summary>
[ApiMember(Description="The name of the order.")]
public virtual string Name { get; set; }
///<summary>
///Search by using the name of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that starts with the specified value.")]
public virtual string NameStartsWith { get; set; }
///<summary>
///Search by using the name of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that ends with the specified value.")]
public virtual string NameEndsWith { get; set; }
///<summary>
///Search by using the name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that contains the specified value.")]
public virtual string NameContains { get; set; }
///<summary>
///Search by using the name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that contains the specified value.")]
public virtual string ServiceName { get; set; }
///<summary>
///Search by using the service name of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that starts with the specified value.")]
public virtual string ServiceNameStartsWith { get; set; }
///<summary>
///Search by using the service name of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that ends with the specified value.")]
public virtual string ServiceNameEndsWith { get; set; }
///<summary>
///Search by using the service name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that contains the specified value.")]
public virtual string ServiceNameContains { get; set; }
///<summary>
///Search for orders placed before a certain date and time. The specified date is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")]
public virtual DateTime? Before { get; set; }
///<summary>
///Search for orders placed after a certain date and time. The specified date is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")]
public virtual DateTime? After { get; set; }
///<summary>
///Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")]
public virtual DateTime? PeriodStartDate { get; set; }
///<summary>
///Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")]
public virtual DateTime? PeriodEndDate { get; set; }
///<summary>
///Search for orders placed within the last 180 days. Today is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")]
public virtual PeriodMode? PeriodMode { get; set; }
///<summary>
///Was the order request successful?
///</summary>
[ApiMember(Description="Was the order request successful?")]
public virtual bool? OrderRequestSucceeded { get; set; }
///<summary>
///The unit of measurement for the order.
///</summary>
[ApiMember(Description="The unit of measurement for the order.")]
public virtual string UnitOfMeasurement { get; set; }
///<summary>
///Search by using the unit of measurement of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")]
public virtual string UnitOfMeasurementStartsWith { get; set; }
///<summary>
///Search by using the unit of measurement of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")]
public virtual string UnitOfMeasurementEndsWith { get; set; }
///<summary>
///Search by using the unit of measurement of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")]
public virtual string UnitOfMeasurementContains { 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.")]
public virtual string ProcessType { get; set; }
///<summary>
///Search by using the process type of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that starts with the specified value.")]
public virtual string ProcessTypeStartsWith { get; set; }
///<summary>
///Search by using the process type of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that ends with the specified value.")]
public virtual string ProcessTypeEndsWith { get; set; }
///<summary>
///Search by using the process type of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that contains the specified value.")]
public virtual string ProcessTypeContains { 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.")]
public virtual string DataType { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")]
public virtual string DataTypeStartsWith { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")]
public virtual string DataTypeEndsWith { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")]
public virtual string DataTypeContains { 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.")]
public virtual string DataName { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")]
public virtual string DataNameStartsWith { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")]
public virtual string DataNameEndsWith { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")]
public virtual string DataNameContains { get; set; }
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
///<summary>
///Specifies a service request from a standard user to search for orders.
///</summary>
[Api(Description="Specifies a service request from a standard user to search for orders.")]
public partial class SearchOrdersBase
: PaginationBase, IGet
{
///<summary>
///The user name of the account.
///</summary>
[ApiMember(Description="The user name of the account.")]
public virtual string UserName { get; set; }
///<summary>
///The name of the order.
///</summary>
[ApiMember(Description="The name of the order.")]
public virtual string Name { get; set; }
///<summary>
///Search by using the name of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that starts with the specified value.")]
public virtual string NameStartsWith { get; set; }
///<summary>
///Search by using the name of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that ends with the specified value.")]
public virtual string NameEndsWith { get; set; }
///<summary>
///Search by using the name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that contains the specified value.")]
public virtual string NameContains { get; set; }
///<summary>
///Search by using the name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of the order that contains the specified value.")]
public virtual string ServiceName { get; set; }
///<summary>
///Search by using the service name of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that starts with the specified value.")]
public virtual string ServiceNameStartsWith { get; set; }
///<summary>
///Search by using the service name of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that ends with the specified value.")]
public virtual string ServiceNameEndsWith { get; set; }
///<summary>
///Search by using the service name of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the service name of the order that contains the specified value.")]
public virtual string ServiceNameContains { get; set; }
///<summary>
///Search for orders placed before a certain date and time. The specified date is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")]
public virtual DateTime? Before { get; set; }
///<summary>
///Search for orders placed after a certain date and time. The specified date is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")]
public virtual DateTime? After { get; set; }
///<summary>
///Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")]
public virtual DateTime? PeriodStartDate { get; set; }
///<summary>
///Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")]
public virtual DateTime? PeriodEndDate { get; set; }
///<summary>
///Search for orders placed within the last 180 days. Today is included in the search.
///</summary>
[ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")]
public virtual PeriodMode? PeriodMode { get; set; }
///<summary>
///Was the order request successful?
///</summary>
[ApiMember(Description="Was the order request successful?")]
public virtual bool? OrderRequestSucceeded { get; set; }
///<summary>
///The unit of measurement for the order.
///</summary>
[ApiMember(Description="The unit of measurement for the order.")]
public virtual string UnitOfMeasurement { get; set; }
///<summary>
///Search by using the unit of measurement of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")]
public virtual string UnitOfMeasurementStartsWith { get; set; }
///<summary>
///Search by using the unit of measurement of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")]
public virtual string UnitOfMeasurementEndsWith { get; set; }
///<summary>
///Search by using the unit of measurement of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")]
public virtual string UnitOfMeasurementContains { 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.")]
public virtual string ProcessType { get; set; }
///<summary>
///Search by using the process type of the order that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that starts with the specified value.")]
public virtual string ProcessTypeStartsWith { get; set; }
///<summary>
///Search by using the process type of the order that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that ends with the specified value.")]
public virtual string ProcessTypeEndsWith { get; set; }
///<summary>
///Search by using the process type of the order that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the process type of the order that contains the specified value.")]
public virtual string ProcessTypeContains { 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.")]
public virtual string DataType { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")]
public virtual string DataTypeStartsWith { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")]
public virtual string DataTypeEndsWith { get; set; }
///<summary>
///Search by using the type of data, for which the order is charged that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")]
public virtual string DataTypeContains { 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.")]
public virtual string DataName { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that starts with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")]
public virtual string DataNameStartsWith { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that ends with the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")]
public virtual string DataNameEndsWith { get; set; }
///<summary>
///Search by using the name of data, for which the order is charged that contains the specified value.
///</summary>
[ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")]
public virtual string DataNameContains { get; set; }
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
}
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
: QueryResponse<Order>
{
public OrderQueryResponse()
{
Results = new List<Order>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<Order> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /async/orders/search 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"}}}