OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the "Estate" resource with the "Get Many" operation, it retrieves multiple estate records from the OnOffice system based on specified criteria. This is useful in scenarios where you want to fetch a list of estates with selected fields and optional filtering, pagination (limit and offset), enabling efficient querying of large datasets.

Practical examples include:

  • Fetching a list of available properties with specific details like ID, title, and external number.
  • Retrieving estates that match certain filter criteria, such as location or price range.
  • Paginating through estates when displaying them in batches in an application or dashboard.

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 (from metadata).

Example output structure:

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Apartment",
      "objektnr_extern": "EXT456"
      // other requested fields...
    },
    // more estate objects...
  ],
  "total": 150
}

No binary data is returned by this operation.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Invalid JSON in Filter: If the filter field is not valid JSON, the node throws an error "Filter must be a valid JSON". Ensure the filter input is correctly formatted JSON.
  • API Authentication Errors: Errors related to invalid or missing API tokens/secrets will cause API errors. Verify credentials are correctly set.
  • Network Issues: Network errors during the HTTP request will result in a "Network error" message. Check network connectivity and API availability.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error indicating the unsupported action.
  • Data Parsing Errors: For create/update operations (not relevant here), invalid JSON in the data field causes errors; ensure JSON validity.

Links and References

Discussion