POST api/progression/lettings/referencetenant?id={id}&tenantPersonId={tenantPersonId}&referenceStatus={referenceStatus}&referenceType={referenceType}&name={name}¬es={notes}&referenceDate={referenceDate}
Reference a tenant on a tenant role
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the tenant role |
integer |
Required |
| tenantPersonId |
The id of the person to reference |
integer |
Required |
| referenceStatus |
Whether the tenant has passed referencing or not |
string |
Required |
| referenceType |
Date of the reference if null today is used |
string |
Required |
| name |
The id of the person to reference |
string |
None. |
| notes |
Notes for the reference |
string |
None. |
| referenceDate |
Date of the reference if null today is used |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
ReferenceDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Negotiator | NegotiatorDataContract |
None. |
|
| ReferenceDate | date |
None. |
|
| Documents | Collection of DocumentDataContract |
None. |
|
| ReferenceName | string |
None. |
|
| ReferenceType | EnumDataContract |
None. |
|
| ReferenceStatus | EnumDataContract |
None. |
|
| Notes | string |
None. |
|
| PersonId | integer |
None. |
|
| Id | integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.