POST api/Dna/GetResidentLink

Get a conservice resident dna link to embed resident bill information in non-conservice applications.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ResidentId	string	None.
PropertyId	string	None.
LeaseId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ResidentId": "sample string 1",
  "PropertyId": "sample string 2",
  "LeaseId": "sample string 3"
}

application/xml, text/xml

Sample:

<LinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ResidentDnaBase.BOL">
  <LeaseId>sample string 3</LeaseId>
  <PropertyId>sample string 2</PropertyId>
  <ResidentId>sample string 1</ResidentId>
</LinkRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DNAResponse

Name	Type	Additional information
DnaLink	string	None.
ErrorMessage	string	None.
SupportEmail	string	None.
Code	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DnaLink": "sample string 1",
  "ErrorMessage": "sample string 2",
  "SupportEmail": "sample string 3",
  "Code": "sample string 4"
}

application/xml, text/xml

Sample:

<DNAResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ResidentDnaApi.Models">
  <Code>sample string 4</Code>
  <DnaLink>sample string 1</DnaLink>
  <ErrorMessage>sample string 2</ErrorMessage>
  <SupportEmail>sample string 3</SupportEmail>
</DNAResponse>