POST api/progression/lettings/{id}/markrighttorentreceived?tenantPersonId={tenantPersonId}&received={received}&rightToRentType={rightToRentType}&rightToRentStatus={rightToRentStatus}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Tenant Role Id |
integer |
Required |
| tenantPersonId |
Tenant Person Id |
integer |
Required |
| received | boolean |
Required |
|
| rightToRentType |
Right to rent type (British/Foreign) |
string |
Required |
| rightToRentStatus | RightToRentStatusType |
Default value is None |
Body Parameters
None.
Response Information
Resource Description
RightToRentReceivedDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId | integer |
None. |
|
| Received | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"PersonId": 1,
"Received": true
}