POST api/progression/lettings/{id}/markrighttorentreceived?tenantPersonId={tenantPersonId}&received={received}&rightToRentType={rightToRentType}&rightToRentStatus={rightToRentStatus}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Dezrez.Rezi.Domain.People.RightToRentStatusType

Default value is None

Body Parameters

None.

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Lettings.Query.RightToRentReceivedDataContract
NameDescriptionTypeAdditional information
PersonId

integer

None.

Received

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "PersonId": 1,
  "Received": true
}