POST api/tenancy/{id}/renew

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lettings.Command.RenewTenancyDataContract

Name	Type	Additional information
RentAmount	decimal number	None.
DepositAmount	decimal number	None.
DepositProtectionStatus	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
DepositScheme	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
StartDate	date	None.
EndDate	date	None.
RentSchedule	Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract	None.
Term	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FurnishLevel	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
AdditionalClauses	Collection of Dezrez.Core.DataContracts.External.Api.Role.Command.AddTenantClause.AddTenantClauseDataContract	None.
PriceType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RenewTenancyDataContract'.

application/json, text/json

Sample:

{
  "RentAmount": 1.0,
  "DepositAmount": 1.0,
  "DepositProtectionStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2024-04-25T19:33:46.3667111Z",
  "EndDate": "2024-04-25T19:33:46.3667111Z",
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2024-04-25T19:33:46.3667111Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FurnishLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AdditionalClauses": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ClauseType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ForceUpdate": true,
      "Id": 4
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ClauseType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ForceUpdate": true,
      "Id": 4
    }
  ],
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.