Required role: | Admin | Required permission: | CanAccess |
GET | /async/products/search |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | query | int? | No | The unique identifier of the account associated with the product. |
AccountId | query | int? | No | The unique identifier of the account associated with the product. |
Name | query | string | No | The name of the product. |
NameStartsWith | query | string | No | Search by using the name of the product that starts with the specified value. |
NameEndsWith | query | string | No | Search by using the name of the product that ends with the specified value. |
NameContains | query | string | No | Search by using the name of the product that contains the specified value. |
Version | query | string | No | The version of the product. |
VersionStartsWith | query | string | No | Search by using the version of the product that starts with the specified value. |
VersionEndsWith | query | string | No | Search by using the version of the product that ends with the specified value. |
VersionContains | query | string | No | Search by using the version of the product that contains the specified value. |
Description | query | string | No | The description of the product. |
DescriptionStartsWith | query | string | No | Search by using the description of the product that starts with the specified value. |
DescriptionEndsWith | query | string | No | Search by using the description of the product that ends with the specified value. |
DescriptionContains | query | string | No | Search by using the description of the product that contains the specified value. |
IncludeOrders | query | bool? | No | Should the related orders of the account be included in the retrieved products? |
SkipOrders | query | int? | No | Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. |
TakeOrders | query | int? | No | Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. |
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 |
---|---|---|---|---|
ProductId | form | int? | No | The unique identifier of the account associated with the product. |
AccountId | form | int? | No | The unique identifier of the account associated with the product. |
Name | form | string | No | The name of the product. |
NameStartsWith | form | string | No | Search by using the name of the product that starts with the specified value. |
NameEndsWith | form | string | No | Search by using the name of the product that ends with the specified value. |
NameContains | form | string | No | Search by using the name of the product that contains the specified value. |
Version | form | string | No | The version of the product. |
VersionStartsWith | form | string | No | Search by using the version of the product that starts with the specified value. |
VersionEndsWith | form | string | No | Search by using the version of the product that ends with the specified value. |
VersionContains | form | string | No | Search by using the version of the product that contains the specified value. |
Description | form | string | No | The description of the product. |
DescriptionStartsWith | form | string | No | Search by using the description of the product that starts with the specified value. |
DescriptionEndsWith | form | string | No | Search by using the description of the product that ends with the specified value. |
DescriptionContains | form | string | No | Search by using the description of the product that contains the specified value. |
IncludeOrders | form | bool? | No | Should the related orders of the account be included in the retrieved products? |
SkipOrders | form | int? | No | Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. |
TakeOrders | form | int? | No | Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. |
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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrdersMap | form | Dictionary<int, List<Order>> | Yes | The dictionary of orders associated with each found product. |
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Product> | 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 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /async/products/search HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"ordersMap":{"0":[{"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}]},"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}