POST api/list/lettingproperty/csv
Generates a csv file from selected letting property list items
Request Information
URI Parameters
None.
Body Parameters
PropertyListCsvCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| 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": "2025-11-16T08:03:31.8344346Z",
"ExchangeTo": "2025-11-16T08:03:31.8344346Z",
"Exchange": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"CompletionsFrom": "2025-11-16T08:03:31.8344346Z",
"CompletionsTo": "2025-11-16T08:03:31.8344346Z",
"Completions": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"OfferAcceptedFrom": "2025-11-16T08:03:31.8344346Z",
"OfferAcceptedTo": "2025-11-16T08:03:31.8344346Z",
"OfferAccepted": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"InstructedFrom": "2025-11-16T08:03:31.8344346Z",
"InstructedTo": "2025-11-16T08:03:31.8344346Z",
"Instructed": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"WithdrawnInstructionFrom": "2025-11-16T08:03:31.8344346Z",
"WithdrawnInstructionTo": "2025-11-16T08:03:31.8344346Z",
"WithdrawnInstruction": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"ValuedFrom": "2025-11-16T08:03:31.8344346Z",
"ValuedTo": "2025-11-16T08:03:31.8344346Z",
"Valued": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"WithdrawnValuationFrom": "2025-11-16T08:03:31.8344346Z",
"WithdrawnValuationTo": "2025-11-16T08:03:31.8344346Z",
"WithdrawnValuation": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"CreatedFrom": "2025-11-16T08:03:31.8344346Z",
"CreatedTo": "2025-11-16T08:03:31.8344346Z",
"Created": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"UpdatedFrom": "2025-11-16T08:03:31.8344346Z",
"UpdatedTo": "2025-11-16T08:03:31.8344346Z",
"Updated": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"ContractEndDateFrom": "2025-11-16T08:03:31.8344346Z",
"ContractEndDateTo": "2025-11-16T08:03:31.8344346Z",
"ContractEndDate": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"LetFrom": "2025-11-16T08:03:31.8344346Z",
"LetTo": "2025-11-16T08:03:31.8344346Z",
"Let": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"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": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"PropertyMarketingDate": {
"FromStaticDate": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"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": "2025-11-16T08:03:31.8344346Z",
"ToStaticDate": "2025-11-16T08:03:31.8344346Z",
"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
JobInvocationDetailsDataContract| Name | Description | Type | Additional 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": "39f8ea4a-04f3-46c4-9835-ee9570bc5157",
"Success": true
}