POST api/list/property?pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.Property.Filter.PropertyListFilterDataContract
NameDescriptionTypeAdditional information
Ids

Collection of integer

None.

NegotiatorIds

Collection of integer

None.

OwningTeamIds

Collection of integer

None.

ExchangedRecordedBy

Collection of integer

None.

ExchangeFrom

date

None.

ExchangeTo

date

None.

Exchange

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

CompletionsFrom

date

None.

CompletionsTo

date

None.

Completions

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

OfferAcceptedFrom

date

None.

OfferAcceptedTo

date

None.

OfferAccepted

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

InstructedFrom

date

None.

InstructedTo

date

None.

Instructed

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

WithdrawnInstructionFrom

date

None.

WithdrawnInstructionTo

date

None.

WithdrawnInstruction

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

ValuedFrom

date

None.

ValuedTo

date

None.

Valued

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

WithdrawnValuationFrom

date

None.

WithdrawnValuationTo

date

None.

WithdrawnValuation

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

CreatedFrom

date

None.

CreatedTo

date

None.

Created

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

UpdatedFrom

date

None.

UpdatedTo

date

None.

Updated

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

ContractEndDateFrom

date

None.

ContractEndDateTo

date

None.

ContractEndDate

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

LetFrom

date

None.

LetTo

date

None.

Let

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

BedroomsMin

integer

None.

PriceRangeMin

integer

None.

PriceRangeMax

integer

None.

PriceType

string

None.

TagIds

Collection of integer

None.

RoleTypes

Collection of string

None.

RoleStatuses

Collection of string

None.

PropertyTypes

Collection of string

None.

MarketingFlags

Dictionary of string [key] and boolean [value]

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

MileRadius

decimal number

None.

Sort

Dezrez.Core.DataContracts.External.Api.Lists.Property.PropertyListSort

None.

RegionIds

Collection of integer

None.

RegionId

integer

None.

RegionSource

string

None.

RegionType

string

None.

ReferralType

string

None.

AdditionalIds

Collection of integer

None.

ExcludedIds

Collection of integer

None.

PropertyIds

Collection of integer

None.

PropertyAddressIds

Collection of string

None.

IsThereEpcValuesRecorded

boolean

None.

SearchOwnersWithTerm

boolean

None.

EpcExpiryDate

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

PropertyMarketingDate

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

IsEmbeddedSearchList

boolean

None.

PreviousPage

integer

None.

PreviousElasticSearchIndex

integer

None.

ClosingDate

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

Name

string

None.

CustomFilterConfig

string

None.

BranchId

integer

None.

BranchIds

Collection of integer

None.

EventBranchIds

Collection of integer

None.

Order

Dezrez.Core.DataContracts.External.Api.Lists.ListOrder

None.

SearchTerm

string

None.

FilterType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ShowDeleted

boolean

None.

ShowCancelled

boolean

None.

OwningTeamId

integer

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Ids": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    2
  ],
  "OwningTeamIds": [
    1,
    2
  ],
  "ExchangedRecordedBy": [
    1,
    2
  ],
  "ExchangeFrom": "2024-11-04T18:42:53.0386349Z",
  "ExchangeTo": "2024-11-04T18:42:53.0386349Z",
  "Exchange": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CompletionsFrom": "2024-11-04T18:42:53.0386349Z",
  "CompletionsTo": "2024-11-04T18:42:53.0386349Z",
  "Completions": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferAcceptedFrom": "2024-11-04T18:42:53.0386349Z",
  "OfferAcceptedTo": "2024-11-04T18:42:53.0386349Z",
  "OfferAccepted": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "InstructedFrom": "2024-11-04T18:42:53.0386349Z",
  "InstructedTo": "2024-11-04T18:42:53.0386349Z",
  "Instructed": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnInstructionFrom": "2024-11-04T18:42:53.0386349Z",
  "WithdrawnInstructionTo": "2024-11-04T18:42:53.0386349Z",
  "WithdrawnInstruction": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ValuedFrom": "2024-11-04T18:42:53.0386349Z",
  "ValuedTo": "2024-11-04T18:42:53.0386349Z",
  "Valued": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnValuationFrom": "2024-11-04T18:42:53.0386349Z",
  "WithdrawnValuationTo": "2024-11-04T18:42:53.0386349Z",
  "WithdrawnValuation": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2024-11-04T18:42:53.0386349Z",
  "CreatedTo": "2024-11-04T18:42:53.0386349Z",
  "Created": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpdatedFrom": "2024-11-04T18:42:53.0386349Z",
  "UpdatedTo": "2024-11-04T18:42:53.0386349Z",
  "Updated": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ContractEndDateFrom": "2024-11-04T18:42:53.0386349Z",
  "ContractEndDateTo": "2024-11-04T18:42:53.0386349Z",
  "ContractEndDate": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "LetFrom": "2024-11-04T18:42:53.0386349Z",
  "LetTo": "2024-11-04T18:42:53.0386349Z",
  "Let": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "BedroomsMin": 1,
  "PriceRangeMin": 1,
  "PriceRangeMax": 1,
  "PriceType": "sample string 2",
  "TagIds": [
    1,
    2
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "MarketingFlags": {
    "sample string 1": true,
    "sample string 3": true
  },
  "Latitude": 1.1,
  "Longitude": 1.1,
  "MileRadius": 1.1,
  "Sort": 0,
  "RegionIds": [
    1,
    2
  ],
  "RegionId": 1,
  "RegionSource": "sample string 3",
  "RegionType": "sample string 4",
  "ReferralType": "sample string 5",
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "PropertyIds": [
    1,
    2
  ],
  "PropertyAddressIds": [
    "sample string 1",
    "sample string 2"
  ],
  "IsThereEpcValuesRecorded": true,
  "SearchOwnersWithTerm": true,
  "EpcExpiryDate": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "PropertyMarketingDate": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "IsEmbeddedSearchList": true,
  "PreviousPage": 7,
  "PreviousElasticSearchIndex": 8,
  "ClosingDate": {
    "FromStaticDate": "2024-11-04T18:42:53.0386349Z",
    "ToStaticDate": "2024-11-04T18:42:53.0386349Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "Name": "sample string 9",
  "CustomFilterConfig": "sample string 10",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 11",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 14,
  "Id": 15
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Property.PropertyListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Property.PropertyListDataContract

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.