Tax Filing Service

<back to all web services

AdminSearchOrders

SearchOrdersSync

Represents a service request from an admin user to search for orders.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/admin/orders/search
AdminSearchOrdersBase Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNoThe user name of the account.
OrderIdformint?NoThe unique identifier of the order.
ProductIdformint?NoThe unique identifier of the product, for which the order is made.
AccountIdformint?NoThe unique identifier of the user account, who made the order.
NameformstringNoThe name of the order.
NameStartsWithformstringNoSearch by using the name of the order that starts with the specified value.
NameEndsWithformstringNoSearch by using the name of the order that ends with the specified value.
NameContainsformstringNoSearch by using the name of the order that contains the specified value.
ServiceNameformstringNoSearch by using the name of the order that contains the specified value.
ServiceNameStartsWithformstringNoSearch by using the service name of the order that starts with the specified value.
ServiceNameEndsWithformstringNoSearch by using the service name of the order that ends with the specified value.
ServiceNameContainsformstringNoSearch by using the service name of the order that contains the specified value.
BeforeformDateTime?NoSearch for orders placed before a certain date and time. The specified date is included in the search.
AfterformDateTime?NoSearch for orders placed after a certain date and time. The specified date is included in the search.
PeriodStartDateformDateTime?NoSearch 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.
PeriodEndDateformDateTime?NoSearch 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.
PeriodModeformPeriodMode?NoSearch for orders placed within the last 180 days. Today is included in the search.
IncludeTestOrdersformbool?NoInclude orders that are simulated for test purposes in the search results?
RequestUriformstringNoThe URI from which the order was initiated.
RequestHttpMethodformstringNoThe HTTP method of the order request.
OrderRequestSucceededformbool?NoWas the order request successful?
ClientIPAddressformstringNoThe initial IP address of client, who made the order.
UnitOfMeasurementformstringNoThe unit of measurement for the order.
UnitOfMeasurementStartsWithformstringNoSearch by using the unit of measurement of the order that starts with the specified value.
UnitOfMeasurementEndsWithformstringNoSearch by using the unit of measurement of the order that ends with the specified value.
UnitOfMeasurementContainsformstringNoSearch by using the unit of measurement of the order that contains the specified value.
ProcessTypeformstringNoThe type of process, for which the order is charged.
ProcessTypeStartsWithformstringNoSearch by using the process type of the order that starts with the specified value.
ProcessTypeEndsWithformstringNoSearch by using the process type of the order that ends with the specified value.
ProcessTypeContainsformstringNoSearch by using the process type of the order that contains the specified value.
DataTypeformstringNoThe type of data, for which the order is charged.
DataTypeStartsWithformstringNoSearch by using the type of data, for which the order is charged that starts with the specified value.
DataTypeEndsWithformstringNoSearch by using the type of data, for which the order is charged that ends with the specified value.
DataTypeContainsformstringNoSearch by using the type of data, for which the order is charged that contains the specified value.
DataNameformstringNoThe name of the data, for which the order is charged.
DataNameStartsWithformstringNoSearch by using the name of data, for which the order is charged that starts with the specified value.
DataNameEndsWithformstringNoSearch by using the name of data, for which the order is charged that ends with the specified value.
DataNameContainsformstringNoSearch by using the name of data, for which the order is charged that contains the specified value.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PeriodMode Enum:
TodayToday
YesterdaySince yesterday
LastWeekSince last week
Last30DaysPast 30 days
Last90DaysPast 90 days
Last180DaysPast 180 days
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the order.
ProductIdformintYesThe unique identifier of the product, for which the order is made.
AccountIdformintYesThe unique identifier of the user account, who placed the order.
NameformstringYesA name to identify the order.
ServiceNameformstringNoThe name of the service, for which the order was made.
RequestTimestampformDateTime?NoThe time stamp at which the order was initiated.
ResponseTimestampformDateTime?NoThe time stamp at which the order was completed.
RequestUriformstringNoThe URI from which the order was initiated.
RequestHttpMethodformstringNoThe HTTP method of the order request.
RequestDurationformTimeSpan?NoThe duration of the order request.
ResponseStatusCodeformHttpStatusCodeNoThe HTTP status code of the order request.
ClientIPAddressformstringNoThe IP address of client, who placed the order.
UnitOfMeasurementformstringNoThe unit of measurement for the order.
ProcessTypeformstringNoThe type of process, for which the order is charged.
DataTypeformstringNoThe type of data, for which the order is charged.
DataNameformstringNoThe name of the data, for which the order is charged.
CreationDateformDateTimeNoThe date of creation of the order.
ExpiryDateformDateTime?NoThe final date to retain the order in the records. After this date, the order is expunged from the records.
IsTestformboolNoIndicates 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

HTTP + XML

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

GET /sync/admin/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>