POST api/addresses/GetAllAddressesWithDynamicFilter
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.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
ResponseModelOfListOfAddressesDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| data | Collection of AddressesDTO |
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,
"userid": 2,
"addressline1": "sample string 3",
"addressline2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"country": "sample string 7",
"postalcode": "sample string 8",
"isdefault": true,
"addresstype": "sample string 9",
"createdat": "2025-12-17T10:12:34.899574+03:00",
"updatedat": "2025-12-17T10:12:34.899574+03:00"
},
{
"id": 1,
"userid": 2,
"addressline1": "sample string 3",
"addressline2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"country": "sample string 7",
"postalcode": "sample string 8",
"isdefault": true,
"addresstype": "sample string 9",
"createdat": "2025-12-17T10:12:34.899574+03:00",
"updatedat": "2025-12-17T10:12:34.899574+03:00"
}
],
"success": true,
"statusCode": 2,
"message": "sample string 3",
"errorMessage": "sample string 4",
"metadata": {}
}
application/xml, text/xml
Sample:
<ResponseModelOfArrayOfAddressesDTOqOm1f5oC xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox.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.Models.DTOs">
<d2p1:AddressesDTO>
<d2p1:AddressLine1>sample string 3</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 4</d2p1:AddressLine2>
<d2p1:AddressType>sample string 9</d2p1:AddressType>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:Country>sample string 7</d2p1:Country>
<d2p1:CreatedAt>2025-12-17T10:12:34.899574+03:00</d2p1:CreatedAt>
<d2p1:ID>1</d2p1:ID>
<d2p1:IsDefault>true</d2p1:IsDefault>
<d2p1:PostalCode>sample string 8</d2p1:PostalCode>
<d2p1:State>sample string 6</d2p1:State>
<d2p1:UpdatedAt>2025-12-17T10:12:34.899574+03:00</d2p1:UpdatedAt>
<d2p1:UserID>2</d2p1:UserID>
</d2p1:AddressesDTO>
<d2p1:AddressesDTO>
<d2p1:AddressLine1>sample string 3</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 4</d2p1:AddressLine2>
<d2p1:AddressType>sample string 9</d2p1:AddressType>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:Country>sample string 7</d2p1:Country>
<d2p1:CreatedAt>2025-12-17T10:12:34.899574+03:00</d2p1:CreatedAt>
<d2p1:ID>1</d2p1:ID>
<d2p1:IsDefault>true</d2p1:IsDefault>
<d2p1:PostalCode>sample string 8</d2p1:PostalCode>
<d2p1:State>sample string 6</d2p1:State>
<d2p1:UpdatedAt>2025-12-17T10:12:34.899574+03:00</d2p1:UpdatedAt>
<d2p1:UserID>2</d2p1:UserID>
</d2p1:AddressesDTO>
</Data>
</ResponseModelOfArrayOfAddressesDTOqOm1f5oC>