OnOffice

Consume OnOffice API

Actions12

Estate → Get Many

AI-generated

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, for the Estate resource and the Get Many operation, it retrieves multiple estate records from the OnOffice system based on specified criteria.

Common scenarios where this node is beneficial include:

  • Fetching a list of estates with selected fields for display or further processing.
  • Querying estates with filters such as location, price range, or other custom criteria.
  • Paginating through large sets of estate data using limit and offset parameters.

Practical example:

  • A real estate agency wants to pull all available estates with their titles and external numbers to display on their website. They can use this node to fetch these estates in batches, applying filters if needed, and then process or display the results accordingly.

Properties

Name Meaning
Fields Comma-separated list of estate fields to return (e.g., Id,objekttitel,objektnr_extern).
Additional Fields Collection of optional parameters:
- Filter JSON object defining filter criteria to narrow down the query results.
- Limit Maximum number of estate records to return (default 50).
- Offset Number of records to skip before starting to return results (default 0).

Output

The output is a JSON array where each item contains:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "getMany".
  • data: An array of estate records matching the query, each containing the requested fields.
  • total (optional): Total count of matching records available (if provided by the API).

Example output structure:

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT456"
    },
    {
      "Id": "124",
      "objekttitel": "Modern Apartment",
      "objektnr_extern": "EXT789"
    }
  ],
  "total": 200
}

No binary data is returned by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node uses HMAC signature generation for request authentication.
  • Network access to https://api.onoffice.de/api/v1 is required.
  • Proper configuration of credentials within n8n is necessary to provide the API token and secret securely.

Troubleshooting

  • Invalid JSON in Filter: If the filter field contains invalid JSON, the node will throw an error stating "Filter must be a valid JSON". Ensure the filter input is correctly formatted JSON.
  • Invalid JSON in Data: Although not applicable for Get Many, other operations require valid JSON in the data field; invalid JSON will cause errors.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message prefixed with "OnOffice API error". Check the API credentials, permissions, and request parameters.
  • Network Issues: Network connectivity problems result in errors prefixed with "Network error". Verify internet connection and API endpoint accessibility.
  • Unsupported Resource or Operation: If an unsupported resource or operation is selected, the node throws an error indicating the unsupported choice.

Links and References

Discussion