Required role: | AllowAnyUser | Required permission: | CanAccess |
GET | /sync/orders/search |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | query | string | No | The user name of the account. |
Name | query | string | No | The name of the order. |
NameStartsWith | query | string | No | Search by using the name of the order that starts with the specified value. |
NameEndsWith | query | string | No | Search by using the name of the order that ends with the specified value. |
NameContains | query | string | No | Search by using the name of the order that contains the specified value. |
ServiceName | query | string | No | Search by using the name of the order that contains the specified value. |
ServiceNameStartsWith | query | string | No | Search by using the service name of the order that starts with the specified value. |
ServiceNameEndsWith | query | string | No | Search by using the service name of the order that ends with the specified value. |
ServiceNameContains | query | string | No | Search by using the service name of the order that contains the specified value. |
Before | query | DateTime? | No | Search for orders placed before a certain date and time. The specified date is included in the search. |
After | query | DateTime? | No | Search for orders placed after a certain date and time. The specified date is included in the search. |
PeriodStartDate | query | DateTime? | No | 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. |
PeriodEndDate | query | DateTime? | No | 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. |
PeriodMode | query | PeriodMode? | No | Search for orders placed within the last 180 days. Today is included in the search. |
OrderRequestSucceeded | query | bool? | No | Was the order request successful? |
UnitOfMeasurement | query | string | No | The unit of measurement for the order. |
UnitOfMeasurementStartsWith | query | string | No | Search by using the unit of measurement of the order that starts with the specified value. |
UnitOfMeasurementEndsWith | query | string | No | Search by using the unit of measurement of the order that ends with the specified value. |
UnitOfMeasurementContains | query | string | No | Search by using the unit of measurement of the order that contains the specified value. |
ProcessType | query | string | No | The type of process, for which the order is charged. |
ProcessTypeStartsWith | query | string | No | Search by using the process type of the order that starts with the specified value. |
ProcessTypeEndsWith | query | string | No | Search by using the process type of the order that ends with the specified value. |
ProcessTypeContains | query | string | No | Search by using the process type of the order that contains the specified value. |
DataType | query | string | No | The type of data, for which the order is charged. |
DataTypeStartsWith | query | string | No | Search by using the type of data, for which the order is charged that starts with the specified value. |
DataTypeEndsWith | query | string | No | Search by using the type of data, for which the order is charged that ends with the specified value. |
DataTypeContains | query | string | No | Search by using the type of data, for which the order is charged that contains the specified value. |
DataName | query | string | No | The name of the data, for which the order is charged. |
DataNameStartsWith | query | string | No | Search by using the name of data, for which the order is charged that starts with the specified value. |
DataNameEndsWith | query | string | No | Search by using the name of data, for which the order is charged that ends with the specified value. |
DataNameContains | query | string | No | Search by using the name of data, for which the order is charged that contains the specified value. |
Skip | query | int? | No | The number of query results to skip. |
Take | query | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | form | string | No | The user name of the account. |
Name | form | string | No | The name of the order. |
NameStartsWith | form | string | No | Search by using the name of the order that starts with the specified value. |
NameEndsWith | form | string | No | Search by using the name of the order that ends with the specified value. |
NameContains | form | string | No | Search by using the name of the order that contains the specified value. |
ServiceName | form | string | No | Search by using the name of the order that contains the specified value. |
ServiceNameStartsWith | form | string | No | Search by using the service name of the order that starts with the specified value. |
ServiceNameEndsWith | form | string | No | Search by using the service name of the order that ends with the specified value. |
ServiceNameContains | form | string | No | Search by using the service name of the order that contains the specified value. |
Before | form | DateTime? | No | Search for orders placed before a certain date and time. The specified date is included in the search. |
After | form | DateTime? | No | Search for orders placed after a certain date and time. The specified date is included in the search. |
PeriodStartDate | form | DateTime? | No | 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. |
PeriodEndDate | form | DateTime? | No | 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. |
PeriodMode | form | PeriodMode? | No | Search for orders placed within the last 180 days. Today is included in the search. |
OrderRequestSucceeded | form | bool? | No | Was the order request successful? |
UnitOfMeasurement | form | string | No | The unit of measurement for the order. |
UnitOfMeasurementStartsWith | form | string | No | Search by using the unit of measurement of the order that starts with the specified value. |
UnitOfMeasurementEndsWith | form | string | No | Search by using the unit of measurement of the order that ends with the specified value. |
UnitOfMeasurementContains | form | string | No | Search by using the unit of measurement of the order that contains the specified value. |
ProcessType | form | string | No | The type of process, for which the order is charged. |
ProcessTypeStartsWith | form | string | No | Search by using the process type of the order that starts with the specified value. |
ProcessTypeEndsWith | form | string | No | Search by using the process type of the order that ends with the specified value. |
ProcessTypeContains | form | string | No | Search by using the process type of the order that contains the specified value. |
DataType | form | string | No | The type of data, for which the order is charged. |
DataTypeStartsWith | form | string | No | Search by using the type of data, for which the order is charged that starts with the specified value. |
DataTypeEndsWith | form | string | No | Search by using the type of data, for which the order is charged that ends with the specified value. |
DataTypeContains | form | string | No | Search by using the type of data, for which the order is charged that contains the specified value. |
DataName | form | string | No | The name of the data, for which the order is charged. |
DataNameStartsWith | form | string | No | Search by using the name of data, for which the order is charged that starts with the specified value. |
DataNameEndsWith | form | string | No | Search by using the name of data, for which the order is charged that ends with the specified value. |
DataNameContains | form | string | No | Search by using the name of data, for which the order is charged that contains the specified value. |
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Today | Today |
Yesterday | Since yesterday |
LastWeek | Since last week |
Last30Days | Past 30 days |
Last90Days | Past 90 days |
Last180Days | Past 180 days |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Order> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
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
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/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <OrderQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses"> <Offset xmlns="http://schemas.servicestack.net/types">0</Offset> <Total xmlns="http://schemas.servicestack.net/types">0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types"> <d2p1:Order> <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> </d2p1:Order> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <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> </Meta> </ResponseError> </Errors> <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> </Meta> </ResponseStatus> </OrderQueryResponse>