Overview
This node interacts with the onOffice API to retrieve multiple real estate listings ("Estates") based on various filters and options. It is useful for users who want to fetch a list of estates matching specific criteria such as price range, location, type, status, and more. For example, a real estate agent could use this node to get all active houses for sale in a particular city within a certain price range, sorted by creation date.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching estate records or limit the number of results. |
| Limit | Maximum number of estate records to return (used only if "Return All" is false). |
| Fields | Specific fields to include in each estate record in the response. Options include: Object Number, Title, Description, Price, Living Space, Plot Area, Number of Rooms, Address, Postal Code, City, Country. |
| Filters | Criteria to filter estates by, including: - Status: Active, Inactive, Archived - Type: House, Apartment, Plot, Commercial - Min/Max Price - City - Postal Code - Min/Max Living Space - Number of Rooms - Marketing Type: Sale or Rent |
| Options | Additional query options: - Sort By: Created Date, Modified Date, Price, Living Space - Sort Order: Ascending or Descending - Advanced Filter: JSON for complex queries |
Output
The output is an array of JSON objects representing estate records retrieved from the onOffice API. Each object contains the requested fields specified in the "Fields" property. The structure depends on which fields were selected but typically includes identifiers, descriptive information, pricing, size, location details, and other estate attributes.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the onOffice API.
- The node makes HTTP POST requests to the onOffice API endpoint
/api.php. - No additional external dependencies are required beyond the configured API authentication.
Troubleshooting
- Empty Results: If no estates are returned, verify that your filters are correct and not overly restrictive. Also, check if the "Return All" option is set appropriately.
- Invalid JSON in Advanced Filter: The "Advanced Filter" field expects valid JSON. Malformed JSON will cause errors. Use a JSON validator before inputting.
- API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
- Limit Ignored When Return All is True: The "Limit" property is ignored if "Return All" is enabled; ensure you understand this behavior when expecting limited results.
- Error Messages: Errors from the API are propagated. Common messages may relate to invalid parameters or authentication failures. Review the error message and adjust parameters accordingly.
Links and References
- onOffice API Documentation (general reference for API capabilities)
- JSON Validators (e.g., https://jsonlint.com) for validating advanced filter input