POST api/progression/lettings/{id}/markrighttorentreceived?tenantPersonId={tenantPersonId}&received={received}&rightToRentType={rightToRentType}&rightToRentStatus={rightToRentStatus}
Mark Right Rent Received. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Tenant Role Id |
integer |
Required |
| tenantPersonId |
Tenant Person Id |
integer |
Required |
| received |
The received value supplied with the request. |
boolean |
Required |
| rightToRentType |
Right to rent type (British/Foreign) |
string |
Required |
| rightToRentStatus |
The right to rent status value supplied with the request. |
RightToRentStatusType |
Default value is None |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
RightToRentReceivedDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId |
The unique identifier of the related person resource. |
integer |
None. |
| Received |
Indicates whether received is true. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"PersonId": 1,
"Received": true
}