POST api/addresses/select/{pageNumber}/{pageSize}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageNumber

integer

Required

pageSize

integer

Required

Body Parameters

AddressesFilterCriteriaDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CreatorUserId

globally unique identifier

None.

ProfileId

globally unique identifier

None.

OrganisationId

globally unique identifier

None.

TenantId

globally unique identifier

None.

IsDeleted

boolean

None.

AddressName

string

None.

CreationDateFrom

date

None.

CreationDateTo

date

None.

AddressProperties

Collection of AddressPropertyFilterCriteriaDto

None.

Address_Line1

string

None.

City

string

None.

Postcode

string

None.

OrderByName

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "277b2ac4-dfe1-4e4a-a1b5-64799a0ede78",
  "CreatorUserId": "2ceb1e78-d422-44f4-bf8d-ac463b1715e7",
  "ProfileId": "d0d71da2-5393-4da6-b64c-adb78d2a8048",
  "OrganisationId": "dd2e04e2-20a4-459b-9eda-53d44589b464",
  "TenantId": "daa54c39-bbb3-4b88-bb6f-ecb1bb94c3c8",
  "IsDeleted": true,
  "AddressName": "sample string 1",
  "CreationDateFrom": "2025-12-06T03:06:11.824932+00:00",
  "CreationDateTo": "2025-12-06T03:06:11.824932+00:00",
  "AddressProperties": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Address_Line1": "sample string 2",
  "City": "sample string 3",
  "Postcode": "sample string 4",
  "OrderByName": true
}

application/xml, text/xml

Sample:
<AddressesFilterCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Profile.Models.FilterCriteria">
  <AddressName>sample string 1</AddressName>
  <AddressProperties>
    <AddressPropertyFilterCriteriaDto>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </AddressPropertyFilterCriteriaDto>
    <AddressPropertyFilterCriteriaDto>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </AddressPropertyFilterCriteriaDto>
  </AddressProperties>
  <Address_Line1>sample string 2</Address_Line1>
  <City>sample string 3</City>
  <CreationDateFrom>2025-12-06T03:06:11.824932+00:00</CreationDateFrom>
  <CreationDateTo>2025-12-06T03:06:11.824932+00:00</CreationDateTo>
  <CreatorUserId>2ceb1e78-d422-44f4-bf8d-ac463b1715e7</CreatorUserId>
  <Id>277b2ac4-dfe1-4e4a-a1b5-64799a0ede78</Id>
  <IsDeleted>true</IsDeleted>
  <OrderByName>true</OrderByName>
  <OrganisationId>dd2e04e2-20a4-459b-9eda-53d44589b464</OrganisationId>
  <Postcode>sample string 4</Postcode>
  <ProfileId>d0d71da2-5393-4da6-b64c-adb78d2a8048</ProfileId>
  <TenantId>daa54c39-bbb3-4b88-bb6f-ecb1bb94c3c8</TenantId>
</AddressesFilterCriteriaDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.