POST api/progression/lettings/createpmtenancy

Create a tenant role

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.AddTenantRoleDataContract
NameDescriptionTypeAdditional information
PropertyLettingRoleId

integer

None.

OwningTeamGroupId

integer

None.

LandlordGroupId

integer

None.

TenantGroupId

integer

None.

PropertyId

integer

None.

StartDate

date

None.

EndDate

date

None.

RentAmount

decimal number

None.

PriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Term

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

AgreementType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ServiceLevel

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

TenancyType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

NoticePeriod

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

TenancyRoleStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

DepositScheme

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

DepositAmount

decimal number

None.

RentSchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "PropertyLettingRoleId": 1,
  "OwningTeamGroupId": 2,
  "LandlordGroupId": 3,
  "TenantGroupId": 4,
  "PropertyId": 5,
  "StartDate": "2024-10-15T18:42:43.0749056Z",
  "EndDate": "2024-10-15T18:42:43.0749056Z",
  "RentAmount": 8.0,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AgreementType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ServiceLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "NoticePeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyRoleStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositAmount": 9.1,
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:42:43.0749056Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.