Tax Filing Service

<back to all web services

BatchRevokeOrders

RevokeOrdersSync

Represents a service request to revoke specified orders.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanDelete
The following routes are available for this service:
DELETE/sync/orders/batch
BatchRevokeOrders Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<int>YesThe collection of specified unique identifiers of the orders to delete.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
BatchRevokeOrdersBase Parameters:
NameParameterData TypeRequiredDescription
IdsformList<int>YesThe collection of specified unique identifiers of the orders to delete.
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
OrderQueryResponse Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Order>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /sync/orders/batch HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}