Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/products/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No | The unique identifier of the product. |
| IncludeOrders | query | bool? | No | Should the related orders of the account be included in the retrieved product? |
| SkipOrders | query | int? | No | Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. |
| TakeOrders | query | int? | No | Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The unique identifier of the product. |
| IncludeOrders | form | bool? | No | Should the related orders of the account be included in the retrieved product? |
| SkipOrders | form | int? | No | Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. |
| TakeOrders | form | int? | No | Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Product | form | Product | No | The product data of the response. |
| Orders | form | List<Order> | Yes | The list of orders associated with the encapsulated product. |
| ResponseStatus | form | ResponseStatus | No | Data structure that holds error information from a service operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | Data structure that holds error information from a service operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | Yes | The unique identifier of the product. |
| Index | form | int | Yes | The position of this instance in a collection of 'Product' instances |
| Name | form | string | Yes | The name of the product. |
| Version | form | string | Yes | The version of the product. |
| Description | form | string | No | The version of the product. |
| Tags | form | List<string> | Yes | Tags associated with the product. |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /async/products/{Id} HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"product":{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]},"orders":[{"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}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}