Tax Filing Service
| Required role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /sync/orders/search |
|---|
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.Helpers
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.Helpers
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<Api(Description:="The number of query results to skip.")>
Public Partial Class PaginationBase
Implements IPaginate
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
'''<Summary>
'''Represents a specific time interval, within which, an action was carried out.
'''</Summary>
Public Enum PeriodMode
Today
Yesterday
LastWeek
Last30Days
Last90Days
Last180Days
End Enum
End Namespace
Namespace PwC.Metering.Core.Services.Contracts.Requests
'''<Summary>
'''Represents a service request from a standard user to search for orders.
'''</Summary>
<Api(Description:="Represents a service request from a standard user to search for orders.")>
Public Partial Class SearchOrders
Inherits SearchOrdersBase
'''<Summary>
'''The user name of the account.
'''</Summary>
<ApiMember(Description:="The user name of the account.")>
Public Overridable Property UserName As String
'''<Summary>
'''The name of the order.
'''</Summary>
<ApiMember(Description:="The name of the order.")>
Public Overridable Property Name As String
'''<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 Overridable Property NameStartsWith As String
'''<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 Overridable Property NameEndsWith As String
'''<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 Overridable Property NameContains As String
'''<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 Overridable Property ServiceName As String
'''<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 Overridable Property ServiceNameStartsWith As String
'''<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 Overridable Property ServiceNameEndsWith As String
'''<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 Overridable Property ServiceNameContains As String
'''<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 Overridable Property Before As Nullable(Of Date)
'''<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 Overridable Property After As Nullable(Of Date)
'''<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 Overridable Property PeriodStartDate As Nullable(Of Date)
'''<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 Overridable Property PeriodEndDate As Nullable(Of Date)
'''<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 Overridable Property PeriodMode As Nullable(Of PeriodMode)
'''<Summary>
'''Was the order request successful?
'''</Summary>
<ApiMember(Description:="Was the order request successful?")>
Public Overridable Property OrderRequestSucceeded As Nullable(Of Boolean)
'''<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>
'''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 Overridable Property UnitOfMeasurementStartsWith As String
'''<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 Overridable Property UnitOfMeasurementEndsWith As String
'''<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 Overridable Property UnitOfMeasurementContains 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>
'''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 Overridable Property ProcessTypeStartsWith As String
'''<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 Overridable Property ProcessTypeEndsWith As String
'''<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 Overridable Property ProcessTypeContains 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>
'''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 Overridable Property DataTypeStartsWith As String
'''<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 Overridable Property DataTypeEndsWith As String
'''<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 Overridable Property DataTypeContains 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>
'''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 Overridable Property DataNameStartsWith As String
'''<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 Overridable Property DataNameEndsWith As String
'''<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 Overridable Property DataNameContains As String
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
'''<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
Inherits PaginationBase
Implements IGet
'''<Summary>
'''The user name of the account.
'''</Summary>
<ApiMember(Description:="The user name of the account.")>
Public Overridable Property UserName As String
'''<Summary>
'''The name of the order.
'''</Summary>
<ApiMember(Description:="The name of the order.")>
Public Overridable Property Name As String
'''<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 Overridable Property NameStartsWith As String
'''<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 Overridable Property NameEndsWith As String
'''<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 Overridable Property NameContains As String
'''<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 Overridable Property ServiceName As String
'''<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 Overridable Property ServiceNameStartsWith As String
'''<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 Overridable Property ServiceNameEndsWith As String
'''<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 Overridable Property ServiceNameContains As String
'''<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 Overridable Property Before As Nullable(Of Date)
'''<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 Overridable Property After As Nullable(Of Date)
'''<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 Overridable Property PeriodStartDate As Nullable(Of Date)
'''<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 Overridable Property PeriodEndDate As Nullable(Of Date)
'''<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 Overridable Property PeriodMode As Nullable(Of PeriodMode)
'''<Summary>
'''Was the order request successful?
'''</Summary>
<ApiMember(Description:="Was the order request successful?")>
Public Overridable Property OrderRequestSucceeded As Nullable(Of Boolean)
'''<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>
'''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 Overridable Property UnitOfMeasurementStartsWith As String
'''<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 Overridable Property UnitOfMeasurementEndsWith As String
'''<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 Overridable Property UnitOfMeasurementContains 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>
'''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 Overridable Property ProcessTypeStartsWith As String
'''<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 Overridable Property ProcessTypeEndsWith As String
'''<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 Overridable Property ProcessTypeContains 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>
'''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 Overridable Property DataTypeStartsWith As String
'''<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 Overridable Property DataTypeEndsWith As String
'''<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 Overridable Property DataTypeContains 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>
'''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 Overridable Property DataNameStartsWith As String
'''<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 Overridable Property DataNameEndsWith As String
'''<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 Overridable Property DataNameContains As String
'''<Summary>
'''The number of query results to skip.
'''</Summary>
<ApiMember(Description:="The number of query results to skip.")>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''The number of query results to include.
'''</Summary>
<ApiMember(Description:="The number of query results to include.")>
Public Overridable Property Take As Nullable(Of Integer)
End Class
End Namespace
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
Inherits QueryResponse(Of Order)
Public Sub New()
Results = New List(Of Order)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of Order)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryResponse(Of T)
Public Sub New()
Results = New List(Of T)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of T)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/orders/search HTTP/1.1 Host: taxfiling.pwc.de Accept: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}