POST api/list/lettingproperty/csv

Generates a csv file from selected letting property list items

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.PropertyListCsvCommandDataContract
NameDescriptionTypeAdditional information
Filter

Dezrez.Core.DataContracts.External.Api.Lists.Property.Filter.PropertyListFilterDataContract

None.

Ids

Collection of integer

None.

ExcludedIds

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Filter": {
    "Ids": [
      1,
      2
    ],
    "NegotiatorIds": [
      1,
      2
    ],
    "OwningTeamIds": [
      1,
      2
    ],
    "ExchangedRecordedBy": [
      1,
      2
    ],
    "ExchangeFrom": "2024-10-15T18:23:28.9677041Z",
    "ExchangeTo": "2024-10-15T18:23:28.9677041Z",
    "Exchange": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CompletionsFrom": "2024-10-15T18:23:28.9677041Z",
    "CompletionsTo": "2024-10-15T18:23:28.9677041Z",
    "Completions": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "OfferAcceptedFrom": "2024-10-15T18:23:28.9677041Z",
    "OfferAcceptedTo": "2024-10-15T18:23:28.9677041Z",
    "OfferAccepted": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "InstructedFrom": "2024-10-15T18:23:28.9677041Z",
    "InstructedTo": "2024-10-15T18:23:28.9677041Z",
    "Instructed": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "WithdrawnInstructionFrom": "2024-10-15T18:23:28.9677041Z",
    "WithdrawnInstructionTo": "2024-10-15T18:23:28.9677041Z",
    "WithdrawnInstruction": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "ValuedFrom": "2024-10-15T18:23:28.9677041Z",
    "ValuedTo": "2024-10-15T18:23:28.9677041Z",
    "Valued": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "WithdrawnValuationFrom": "2024-10-15T18:23:28.9677041Z",
    "WithdrawnValuationTo": "2024-10-15T18:23:28.9677041Z",
    "WithdrawnValuation": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2024-10-15T18:23:28.9677041Z",
    "CreatedTo": "2024-10-15T18:23:28.9677041Z",
    "Created": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "UpdatedFrom": "2024-10-15T18:23:28.9677041Z",
    "UpdatedTo": "2024-10-15T18:23:28.9677041Z",
    "Updated": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "ContractEndDateFrom": "2024-10-15T18:23:28.9677041Z",
    "ContractEndDateTo": "2024-10-15T18:23:28.9677041Z",
    "ContractEndDate": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "LetFrom": "2024-10-15T18:23:28.9677041Z",
    "LetTo": "2024-10-15T18:23:28.9677041Z",
    "Let": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "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-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "PropertyMarketingDate": {
      "FromStaticDate": "2024-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "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-10-15T18:23:28.9677041Z",
      "ToStaticDate": "2024-10-15T18:23:28.9677041Z",
      "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
  },
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "78b02518-a7f6-4a57-81f2-7ac18c1346a8",
  "Success": true
}