POST api/crmconnect/property/history/{type}/{propertyId}

Creates a job that would either attach property history to a property, if a propertyid is supplied or notify the user with a link to the generated document. This is so people can see the history for a property without importing it into rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

Sales Or Lettings

string

Required

propertyId

optional property id to attach to

integer

Default value is 0

Body Parameters

A value usable to identify the item in the crm, this key is generated by the selected domain service

Object

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{}

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": "22dc3ff0-b5d1-4573-92e5-c7273dfc738c",
  "Success": true
}