GET ops/housing/houses?plantationId={plantationId}&keywordString={keywordString}&activeLease={activeLease}&expiresOn={expiresOn}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
plantationId | integer |
Default value is 0 |
|
keywordString | string |
None. |
|
activeLease | boolean |
None. |
|
expiresOn | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of HouseGETName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
HouseAddress | string |
None. |
|
Owner | OwnerGET |
None. |
|
Modified | date |
None. |
|
Plantation | PlantationBasicGET |
None. |
|
Status | Status |
None. |
|
ModifiedBy | UserBasicGET |
None. |
|
LatestValuation | ValuationGET |
None. |
|
LatestBudgets | Collection of BudgetGET |
None. |
|
LatestLease | LeaseGET |
None. |
|
LatestMaintenanceAudit | MaintenanceAuditGET |
None. |
|
ActiveMaintenanceSchedules | Collection of MaintenanceScheduleGET |
None. |
|
LatestMeterReadings | Collection of MeterReadingGET |
None. |
|
HouseAttributes | Collection of HouseAttributeGET |
None. |
|
Coordinates | Coordinates |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "houseAddress": "sample string 2", "owner": { "id": 1, "name": "sample string 2" }, "modified": "2024-09-08T06:36:34.4482532+02:00", "plantation": { "id": 1, "name": "sample string 2", "mfCode": "sample string 3" }, "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" }, "latestValuation": { "id": 1, "valuationDate": "2024-09-08T06:36:34.4482532+02:00", "amount": 3.0, "rentAmount": 1.0, "agency": "sample string 4", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "latestBudgets": [ { "id": 1, "amount": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "amount": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "latestLease": { "id": 1, "rent": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "tenant": { "id": 1, "rsaId": "sample string 2", "fullName": "sample string 3", "email": "sample string 4", "contactNo": "sample string 5", "fringeBenifitTotal": 1.0, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "tenantType": { "id": 1, "description": "sample string 2" }, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "latestMaintenanceAudit": { "houseId": 1, "tenantId": 1, "occupantCount": 2, "housingType": "sample string 3", "id": 4, "auditDate": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modified": "2024-09-08T06:36:34.4638555+02:00", "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" }, "auditBy": "sample string 7" }, "activeMaintenanceSchedules": [ { "id": 1, "scheduledDate": "2024-09-08T06:36:34.4638555+02:00", "dateCompleted": "2024-09-08T06:36:34.4638555+02:00", "companyName": "sample string 3", "employeeName": "sample string 4", "houseId": 5, "maintenanceType": { "id": 1, "description": "sample string 2" }, "description": "sample string 6", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "scheduledDate": "2024-09-08T06:36:34.4638555+02:00", "dateCompleted": "2024-09-08T06:36:34.4638555+02:00", "companyName": "sample string 3", "employeeName": "sample string 4", "houseId": 5, "maintenanceType": { "id": 1, "description": "sample string 2" }, "description": "sample string 6", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "latestMeterReadings": [ { "id": 1, "electricityReading": 1, "waterReading": 1, "readingDate": "2024-09-08T06:36:34.4638555+02:00", "houseId": 3, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "electricityReading": 1, "waterReading": 1, "readingDate": "2024-09-08T06:36:34.4638555+02:00", "houseId": 3, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "houseAttributes": [ { "id": 1, "description": "sample string 2", "houseId": 3, "attribute": { "id": 1, "attributeName": "sample string 2", "description": "sample string 3", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "description": "sample string 2", "houseId": 3, "attribute": { "id": 1, "attributeName": "sample string 2", "description": "sample string 3", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "coordinates": null }, { "id": 1, "houseAddress": "sample string 2", "owner": { "id": 1, "name": "sample string 2" }, "modified": "2024-09-08T06:36:34.4482532+02:00", "plantation": { "id": 1, "name": "sample string 2", "mfCode": "sample string 3" }, "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" }, "latestValuation": { "id": 1, "valuationDate": "2024-09-08T06:36:34.4482532+02:00", "amount": 3.0, "rentAmount": 1.0, "agency": "sample string 4", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "latestBudgets": [ { "id": 1, "amount": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "amount": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "latestLease": { "id": 1, "rent": 2.0, "startDate": "2024-09-08T06:36:34.4482532+02:00", "endDate": "2024-09-08T06:36:34.4482532+02:00", "houseId": 5, "tenant": { "id": 1, "rsaId": "sample string 2", "fullName": "sample string 3", "email": "sample string 4", "contactNo": "sample string 5", "fringeBenifitTotal": 1.0, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "tenantType": { "id": 1, "description": "sample string 2" }, "modified": "2024-09-08T06:36:34.4482532+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "latestMaintenanceAudit": { "houseId": 1, "tenantId": 1, "occupantCount": 2, "housingType": "sample string 3", "id": 4, "auditDate": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modified": "2024-09-08T06:36:34.4638555+02:00", "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" }, "auditBy": "sample string 7" }, "activeMaintenanceSchedules": [ { "id": 1, "scheduledDate": "2024-09-08T06:36:34.4638555+02:00", "dateCompleted": "2024-09-08T06:36:34.4638555+02:00", "companyName": "sample string 3", "employeeName": "sample string 4", "houseId": 5, "maintenanceType": { "id": 1, "description": "sample string 2" }, "description": "sample string 6", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "scheduledDate": "2024-09-08T06:36:34.4638555+02:00", "dateCompleted": "2024-09-08T06:36:34.4638555+02:00", "companyName": "sample string 3", "employeeName": "sample string 4", "houseId": 5, "maintenanceType": { "id": 1, "description": "sample string 2" }, "description": "sample string 6", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "latestMeterReadings": [ { "id": 1, "electricityReading": 1, "waterReading": 1, "readingDate": "2024-09-08T06:36:34.4638555+02:00", "houseId": 3, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "electricityReading": 1, "waterReading": 1, "readingDate": "2024-09-08T06:36:34.4638555+02:00", "houseId": 3, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "houseAttributes": [ { "id": 1, "description": "sample string 2", "houseId": 3, "attribute": { "id": 1, "attributeName": "sample string 2", "description": "sample string 3", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, { "id": 1, "description": "sample string 2", "houseId": 3, "attribute": { "id": 1, "attributeName": "sample string 2", "description": "sample string 3", "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } }, "modified": "2024-09-08T06:36:34.4638555+02:00", "status": { "id": 1, "name": "sample string 2" }, "modifiedBy": { "firstName": "sample string 1", "id": 2, "lastName": "sample string 3", "uid": "sample string 4", "username": "sample string 5" } } ], "coordinates": null } ]
application/xml
Sample:
text/xml
Sample: