POST api/products/GetAllProductsWithDynamicFilter
Request Information
URI Parameters
None.
Body Parameters
DynamicFilterRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterGroups | Collection of DynamicFilterGroup |
None. |
|
| GroupOperator | string |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortField | string |
None. |
|
| SortDirection | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FilterGroups": [
{
"GroupId": 1,
"LogicalOperator": "sample string 2",
"Criteria": [
{
"ColumnName": "sample string 1",
"Operand": "sample string 2",
"Value": "sample string 3",
"LogicalOperator": "sample string 4",
"GroupId": 5
},
{
"ColumnName": "sample string 1",
"Operand": "sample string 2",
"Value": "sample string 3",
"LogicalOperator": "sample string 4",
"GroupId": 5
}
]
},
{
"GroupId": 1,
"LogicalOperator": "sample string 2",
"Criteria": [
{
"ColumnName": "sample string 1",
"Operand": "sample string 2",
"Value": "sample string 3",
"LogicalOperator": "sample string 4",
"GroupId": 5
},
{
"ColumnName": "sample string 1",
"Operand": "sample string 2",
"Value": "sample string 3",
"LogicalOperator": "sample string 4",
"GroupId": 5
}
]
}
],
"GroupOperator": "sample string 1",
"PageNumber": 2,
"PageSize": 3,
"SortField": "sample string 4",
"SortDirection": "sample string 5"
}
application/xml, text/xml
Sample:
<DynamicFilterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox_api.Models">
<PageNumber>2</PageNumber>
<PageSize>3</PageSize>
<SortDirection>sample string 5</SortDirection>
<SortField>sample string 4</SortField>
<FilterGroups>
<DynamicFilterGroup>
<Criteria>
<DynamicFilterCriteria>
<ColumnName>sample string 1</ColumnName>
<GroupId>5</GroupId>
<LogicalOperator>sample string 4</LogicalOperator>
<Operand>sample string 2</Operand>
<Value>sample string 3</Value>
</DynamicFilterCriteria>
<DynamicFilterCriteria>
<ColumnName>sample string 1</ColumnName>
<GroupId>5</GroupId>
<LogicalOperator>sample string 4</LogicalOperator>
<Operand>sample string 2</Operand>
<Value>sample string 3</Value>
</DynamicFilterCriteria>
</Criteria>
<GroupId>1</GroupId>
<LogicalOperator>sample string 2</LogicalOperator>
</DynamicFilterGroup>
<DynamicFilterGroup>
<Criteria>
<DynamicFilterCriteria>
<ColumnName>sample string 1</ColumnName>
<GroupId>5</GroupId>
<LogicalOperator>sample string 4</LogicalOperator>
<Operand>sample string 2</Operand>
<Value>sample string 3</Value>
</DynamicFilterCriteria>
<DynamicFilterCriteria>
<ColumnName>sample string 1</ColumnName>
<GroupId>5</GroupId>
<LogicalOperator>sample string 4</LogicalOperator>
<Operand>sample string 2</Operand>
<Value>sample string 3</Value>
</DynamicFilterCriteria>
</Criteria>
<GroupId>1</GroupId>
<LogicalOperator>sample string 2</LogicalOperator>
</DynamicFilterGroup>
</FilterGroups>
<GroupOperator>sample string 1</GroupOperator>
</DynamicFilterRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModelOfListOfProductsDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of ProductsDTO |
None. |
|
| Success | boolean |
None. |
|
| StatusCode | integer |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | string |
None. |
|
| Metadata | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"categoryid": 5,
"category": "sample string 6",
"imageurl": "sample string 7",
"stockquantity": 8,
"rating": 1.0,
"createdat": "2025-12-20T08:40:31.4971932+03:00",
"updatedat": "2025-12-20T08:40:31.4971932+03:00",
"specificationsjson": "sample string 9",
"ispublished": true,
"isenabled": true,
"isdeleted": true
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"categoryid": 5,
"category": "sample string 6",
"imageurl": "sample string 7",
"stockquantity": 8,
"rating": 1.0,
"createdat": "2025-12-20T08:40:31.4971932+03:00",
"updatedat": "2025-12-20T08:40:31.4971932+03:00",
"specificationsjson": "sample string 9",
"ispublished": true,
"isenabled": true,
"isdeleted": true
}
],
"Success": true,
"StatusCode": 2,
"Message": "sample string 3",
"ErrorMessage": "sample string 4",
"Metadata": {}
}
application/xml, text/xml
Sample:
<ResponseModelOfArrayOfProductsDTOb1afPy6h xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox_api.Models.Response">
<ErrorMessage>sample string 4</ErrorMessage>
<Message>sample string 3</Message>
<Metadata />
<StatusCode>2</StatusCode>
<Success>true</Success>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/cbox_api.Models.DTOs">
<d2p1:ProductsDTO>
<d2p1:Category>sample string 6</d2p1:Category>
<d2p1:CategoryID>5</d2p1:CategoryID>
<d2p1:CreatedAt>2025-12-20T08:40:31.4971932+03:00</d2p1:CreatedAt>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ID>1</d2p1:ID>
<d2p1:ImageUrl>sample string 7</d2p1:ImageUrl>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:IsEnabled>true</d2p1:IsEnabled>
<d2p1:IsPublished>true</d2p1:IsPublished>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Price>4</d2p1:Price>
<d2p1:Rating>1</d2p1:Rating>
<d2p1:SpecificationsJson>sample string 9</d2p1:SpecificationsJson>
<d2p1:StockQuantity>8</d2p1:StockQuantity>
<d2p1:UpdatedAt>2025-12-20T08:40:31.4971932+03:00</d2p1:UpdatedAt>
</d2p1:ProductsDTO>
<d2p1:ProductsDTO>
<d2p1:Category>sample string 6</d2p1:Category>
<d2p1:CategoryID>5</d2p1:CategoryID>
<d2p1:CreatedAt>2025-12-20T08:40:31.4971932+03:00</d2p1:CreatedAt>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ID>1</d2p1:ID>
<d2p1:ImageUrl>sample string 7</d2p1:ImageUrl>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:IsEnabled>true</d2p1:IsEnabled>
<d2p1:IsPublished>true</d2p1:IsPublished>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Price>4</d2p1:Price>
<d2p1:Rating>1</d2p1:Rating>
<d2p1:SpecificationsJson>sample string 9</d2p1:SpecificationsJson>
<d2p1:StockQuantity>8</d2p1:StockQuantity>
<d2p1:UpdatedAt>2025-12-20T08:40:31.4971932+03:00</d2p1:UpdatedAt>
</d2p1:ProductsDTO>
</Data>
</ResponseModelOfArrayOfProductsDTOb1afPy6h>