POST api/list/propertynewbusiness/csv

Generates a csv file from selected property list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The list csv command data contract supplied with the request.

ListCsvCommandDataContract
NameDescriptionTypeAdditional information
Ids

The unique identifiers of the related api resources.

Collection of integer

None.

ExcludedIds

The unique identifiers of the related excluded resources.

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

Indicates whether supports cancellation is true.

boolean

None.

ReportsProgress

Indicates whether reports progress is true.

boolean

None.

InitialStatusText

The initial status text value.

string

None.

JobReference

The job reference globally unique identifier.

globally unique identifier

None.

Success

Indicates whether success is true.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "0ab3d2c5-f689-40dd-bc3b-98763111b569",
  "Success": true
}