PUT api/progression/lettings/{id}/settenanthousingbenefits
Set Tenant Housing Benefit. 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 |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
The set tenant housing benefit data contract supplied with the request.
SetTenantHousingBenefitDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupId |
The unique identifier of the related group resource. |
integer |
None. |
| Reference |
The reference value. |
string |
None. |
| ReceivesBenefits |
Indicates whether receives benefits is true. |
boolean |
None. |
| TenantInfoId |
The unique identifier of the related tenant info resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"GroupId": 1,
"Reference": "sample string 2",
"ReceivesBenefits": true,
"TenantInfoId": 4
}
Response Information
Resource Description
The response returned after the operation completes.
TenantHousingBenefitDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| LocalAuthorityId |
The unique identifier of the related local authority resource. |
integer |
None. |
| ReceivesBenefits |
Indicates whether receives benefits is true. |
boolean |
None. |
| Reference |
The reference value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"LocalAuthorityId": 1,
"ReceivesBenefits": true,
"Reference": "sample string 3",
"Id": 4
}