POST api/documents/prospect/{analyzedPropertyId}/report

Use this method to generate marketing report for prospect client requested by influencer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
analyzedPropertyId

Id of the previously analyzed property record

integer

Required

Body Parameters

Instance of

InfluencerReportRequestBinding
NameDescriptionTypeAdditional information
SendReport

boolean

None.

SendReferral

boolean

None.

GetReport

boolean

None.

AffiliateCode

string

Required

ProspectFirstName

string

None.

ProspectLastName

string

None.

ProspectPhone

string

None.

ProspectEmail

string

None.

UserId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "sendReport": true,
  "sendReferral": true,
  "getReport": true,
  "affiliateCode": "sample string 4",
  "prospectFirstName": "sample string 5",
  "prospectLastName": "sample string 6",
  "prospectPhone": "sample string 7",
  "prospectEmail": "sample string 8",
  "userId": "sample string 9"
}

text/html

Sample:
{"sendReport":true,"sendReferral":true,"getReport":true,"affiliateCode":"sample string 4","prospectFirstName":"sample string 5","prospectLastName":"sample string 6","prospectPhone":"sample string 7","prospectEmail":"sample string 8","userId":"sample string 9"}

application/xml, text/xml

Sample:
<InfluencerReportRequestBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.DocumentGeneration">
  <AffiliateCode>sample string 4</AffiliateCode>
  <GetReport>true</GetReport>
  <ProspectEmail>sample string 8</ProspectEmail>
  <ProspectFirstName>sample string 5</ProspectFirstName>
  <ProspectLastName>sample string 6</ProspectLastName>
  <ProspectPhone>sample string 7</ProspectPhone>
  <SendReferral>true</SendReferral>
  <SendReport>true</SendReport>
  <UserId>sample string 9</UserId>
</InfluencerReportRequestBinding>

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 'InfluencerReportRequestBinding'.

Response Information

Resource Description

Instance of

InfluencerResponseModel
NameDescriptionTypeAdditional information
ReportUri

string

None.

AttorneyEmail

string

None.

AttorneyPhone

string

None.

MarketingMessage

string

None.

Content

string

None.

Response Formats

application/json, text/json

Sample:
{
  "reportUri": "sample string 1",
  "attorneyEmail": "sample string 2",
  "attorneyPhone": "sample string 3",
  "marketingMessage": "sample string 4",
  "content": "sample string 5"
}

text/html

Sample:
{"reportUri":"sample string 1","attorneyEmail":"sample string 2","attorneyPhone":"sample string 3","marketingMessage":"sample string 4","content":"sample string 5"}

application/xml, text/xml

Sample:
<InfluencerResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ReportBinding">
  <AttorneyEmail>sample string 2</AttorneyEmail>
  <AttorneyPhone>sample string 3</AttorneyPhone>
  <Content>sample string 5</Content>
  <MarketingMessage>sample string 4</MarketingMessage>
  <ReportUri>sample string 1</ReportUri>
</InfluencerResponseModel>