GET api/tenantreferencing/case/{tenancyRoleId}

Gets a tenancy referencing case based on the role id supplied

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenancyRoleId

The id of the tenancy role the case linked to.

integer

Required

Body Parameters

None.

Response Information

Resource Description

HomeLetCaseDataContract

Dezrez.Core.DataContracts.External.Api.TenantReferencing.HomeLetCaseDataContract
NameDescriptionTypeAdditional information
Id

string

None.

address

Dezrez.Core.DataContracts.External.Api.TenantReferencing.HomeLetAddressDataContract

None.

totalRent

decimal number

None.

tenancyStartDate

string

None.

tenancyTerm

integer

None.

numberOfTenants

integer

None.

propertyType

integer

None.

propertyLetType

integer

None.

rentGuaranteeOfferingType

integer

None.

propertyBuiltInRangeType

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "address": {
    "flat": "sample string 1",
    "houseName": "sample string 2",
    "houseNumber": "sample string 3",
    "street": "sample string 4",
    "town": "sample string 5",
    "postcode": "sample string 6"
  },
  "totalRent": 2.1,
  "tenancyStartDate": "sample string 3",
  "tenancyTerm": 4,
  "numberOfTenants": 5,
  "propertyType": 6,
  "propertyLetType": 7,
  "rentGuaranteeOfferingType": 8,
  "propertyBuiltInRangeType": 9
}