POST api/tenancy/{id}/setrenewaloptions

Set Renewal Options. Processes this tenancy 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 renewal options data contract supplied with the request.

SetRenewalOptionsDataContract

Name	Description	Type	Additional information
LandlordPreference	The landlord preference value.	EnumDataContract	None.
LandlordEndTenancyReason	The landlord end tenancy reason value.	EnumDataContract	None.
LandlordNotes	The landlord notes value.	string	None.
TenantPreference	The tenant preference value.	EnumDataContract	None.
TenantEndTenancyReason	The tenant end tenancy reason value.	EnumDataContract	None.
TenantNotes	The tenant notes value.	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "LandlordPreference": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "LandlordEndTenancyReason": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "LandlordNotes": "sample string 1",
  "TenantPreference": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenantEndTenancyReason": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenantNotes": "sample string 2"
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.