POST api/tenancy/{id}/setdates

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

SetTenancyDatesDataContract
NameDescriptionTypeAdditional information
NoticePeriod

EnumDataContract

None.

StartDate

date

None.

TenancyType

EnumDataContract

None.

Term

EnumDataContract

None.

EndDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "NoticePeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2018-11-14T15:39:21.093698Z",
  "TenancyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EndDate": "2018-11-14T15:39:21.093698Z"
}

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 'SetTenancyDatesDataContract'.

Response Information

Resource Description

TenantRoleDataContract
NameDescriptionTypeAdditional information
AcceptedOffer

LettingOfferDataContract

None.

Deposit

DepositDataContract

None.

RentAmount

decimal number

None.

RentDayDifference

integer

None.

RentPaymentDate

date

None.

RentSchedule

RecurringScheduleDataContract

None.

Term

EnumDataContract

None.

ServiceLevel

EnumDataContract

None.

PriceType

EnumDataContract

None.

BreakClauseType

EnumDataContract

None.

EstimatedStartDate

date

None.

StartDate

date

None.

EndDate

date

None.

RenewalDate

date

None.

MoveInDate

date

None.

Commission

decimal number

None.

TenantInfo

Collection of TenantInfoDataContact

None.

Guarantors

Collection of GuarantorDataContract

None.

PermittedPets

Collection of PermittedPetDataContract

None.

PermittedOccupiers

Collection of PermittedOccupierDataContract

None.

TenantBaseDeposit

TenantDepositDataContract

None.

TenantAdditionalDeposits

Collection of TenantDepositDataContract

None.

TenantFees

Collection of TenantFeeDataContract

None.

TenantBills

Collection of TenantBillDataContract

None.

TenantCharges

Collection of TenantChargeDataContract

None.

Payments

Collection of PaymentDataContract

None.

TenancyStatus

EnumDataContract

None.

TenancyType

EnumDataContract

None.

AgreementType

EnumDataContract

None.

NoticePeriod

EnumDataContract

None.

IssueNoticeDate

date

None.

Requirements

TenantRequirementDataContract

None.

Milestones

Collection of ProgressionMilestoneDataContract

None.

TenantClauses

Collection of TenantClauseDataContract

None.

LettingRoleId

integer

None.

NextAction

TenancyNextActionDataContract

None.

ForwardingAddress

AddressDataContract

None.

TenancyReference

string

None.

OwningTeam

OwningTeamDataContract

None.

Branch

BranchDataContract

None.

FurnishLevel

EnumDataContract

None.

ParkingSpaces

integer

None.

ParkingDescription

string

None.

PropertyAddress

string

None.

AdditionalServices

Collection of AdditionalServiceDataContract

None.

TenancyAgreementId

integer

None.

PropertyId

integer

None.

GroupId

integer

None.

FinancialStatus

EnumDataContract

None.

Origin

EnumDataContract

None.

Grade

EnumDataContract

None.

OwningTeamId

integer

None.

BranchId

integer

None.

Name

string

None.

TeamAccessType

string

None.

RoleType

EnumDataContract

None.

RoleStatus

EnumDataContract

None.

CustomFields

Collection of CustomFieldGroupWithValuesDataContract

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'TenantInfo[0].Guarantors[0].Group.PreferredCompanies[0].Group.PreferredCompanies'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'TenantInfo[0].Guarantors[0].Group.PreferredCompanies[0].Group.PreferredCompanies'.