GET api/CentralProducts/Count
Gets the total (count) of products available
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DeletedProducts |
If the list should only contain deleted products (default false) |
boolean |
None. |
| ModifiedDate |
The modification date (from-date) that should be used to filter products (optional) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| ModifiedEndDate |
The modification end date (to-date) that should be used to filter products (optional) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
URI Example
api/CentralProducts/Count?ModifiedDate={ModifiedDate}&ModifiedEndDate={ModifiedEndDate}&DeletedProducts={DeletedProducts}
Body Parameters
None.
Response Information
Resource Description
A wrapper class with the count
Oresto.API.Models.GET.CentralProducts.ProductCountData| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors |
Possible errors that were experienced when processing the request |
Collection of string |
None. |
| RequestInformation |
Additional information about the request |
Oresto.API.Models.Shared.RequestInformation |
None. |
| TotalProducts |
The amount of products |
integer |
None. |
Response Formats
application/json, text/json
{
"TotalProducts": 1,
"RequestInformation": {
"RequestDuration": 1,
"WholesalerId": 2,
"UserId": 3
},
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
<ProductCountData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.CentralProducts">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<RequestDuration>1</RequestDuration>
<UserId>3</UserId>
<WholesalerId>2</WholesalerId>
</RequestInformation>
<TotalProducts>1</TotalProducts>
</ProductCountData>