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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

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.

CompletionsFrom

date

None.

CompletionsTo

date

None.

OfferAcceptedFrom

date

None.

OfferAcceptedTo

date

None.

InstructedFrom

date

None.

InstructedTo

date

None.

WithdrawnInstructionFrom

date

None.

WithdrawnInstructionTo

date

None.

ValuedFrom

date

None.

ValuedTo

date

None.

WithdrawnValuationFrom

date

None.

WithdrawnValuationTo

date

None.

CreatedFrom

date

None.

CreatedTo

date

None.

UpdatedFrom

date

None.

UpdatedTo

date

None.

ContractEndDateFrom

date

None.

ContractEndDateTo

date

None.

LetFrom

date

None.

LetTo

date

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

PropertyListSort

None.

RegionIds

Collection of integer

None.

RegionId

integer

None.

RegionSource

string

None.

RegionType

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.

Name

string

None.

CustomFilterConfig

string

None.

BranchId

integer

None.

BranchIds

Collection of integer

None.

EventBranchIds

Collection of integer

None.

Order

ListOrder

None.

SearchTerm

string

None.

FilterType

EnumDataContract

None.

ShowDeleted

boolean

None.

ShowCancelled

boolean

None.

OwningTeamId

integer

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Ids": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    2
  ],
  "OwningTeamIds": [
    1,
    2
  ],
  "ExchangedRecordedBy": [
    1,
    2
  ],
  "ExchangeFrom": "2018-11-14T16:30:17.5240493Z",
  "ExchangeTo": "2018-11-14T16:30:17.5240493Z",
  "CompletionsFrom": "2018-11-14T16:30:17.5240493Z",
  "CompletionsTo": "2018-11-14T16:30:17.5240493Z",
  "OfferAcceptedFrom": "2018-11-14T16:30:17.5240493Z",
  "OfferAcceptedTo": "2018-11-14T16:30:17.5240493Z",
  "InstructedFrom": "2018-11-14T16:30:17.5240493Z",
  "InstructedTo": "2018-11-14T16:30:17.5240493Z",
  "WithdrawnInstructionFrom": "2018-11-14T16:30:17.5240493Z",
  "WithdrawnInstructionTo": "2018-11-14T16:30:17.5240493Z",
  "ValuedFrom": "2018-11-14T16:30:17.5240493Z",
  "ValuedTo": "2018-11-14T16:30:17.5240493Z",
  "WithdrawnValuationFrom": "2018-11-14T16:30:17.5240493Z",
  "WithdrawnValuationTo": "2018-11-14T16:30:17.5240493Z",
  "CreatedFrom": "2018-11-14T16:30:17.5240493Z",
  "CreatedTo": "2018-11-14T16:30:17.5240493Z",
  "UpdatedFrom": "2018-11-14T16:30:17.5240493Z",
  "UpdatedTo": "2018-11-14T16:30:17.5240493Z",
  "ContractEndDateFrom": "2018-11-14T16:30:17.5240493Z",
  "ContractEndDateTo": "2018-11-14T16:30:17.5240493Z",
  "LetFrom": "2018-11-14T16:30:17.5240493Z",
  "LetTo": "2018-11-14T16:30:17.5240493Z",
  "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",
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "PropertyIds": [
    1,
    2
  ],
  "PropertyAddressIds": [
    "sample string 1",
    "sample string 2"
  ],
  "IsThereEpcValuesRecorded": true,
  "Name": "sample string 5",
  "CustomFilterConfig": "sample string 6",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 7",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 10,
  "Id": 11
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PropertyListFilterDataContract'.

Response Information

Resource Description

PagedCollectionDataContractOfPropertyListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of PropertyListDataContract

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Collection[0].OfferingGroup.PreferredCompanies[0].Group.PreferredCompanies'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Collection[0].OfferingGroup.PreferredCompanies[0].Group.PreferredCompanies'.