OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, for the Estate - Get operation, it retrieves detailed information about a single real estate record by its unique ID. This is useful in scenarios where you need to fetch specific property details from your OnOffice database within an automated workflow.

Practical examples include:

  • Automatically retrieving property details when a new inquiry is received.
  • Fetching estate information to update CRM records or generate reports.
  • Integrating estate data into other systems like marketing platforms or document generators.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve.
Fields Comma-separated list of fields to return from the estate record (e.g., Id,objekttitel,objektnr_extern).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array of estate records matching the query. For the "Get" operation, this will typically contain one record with the requested fields.
  • total (optional): Total number of records returned (mainly relevant for multi-record queries).
  • message (optional): Status message from the API.

Example output snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": [
    {
      "Id": "12345",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT-6789"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node uses HMAC signature authentication for secure API requests.
  • Network access to https://api.onoffice.de/api/stable/api.php is required.

Troubleshooting

  • Invalid ID or Record Not Found: If the provided estate ID does not exist, the API may return an error or empty data. Verify the ID is correct.
  • Malformed Fields Parameter: The Fields input must be a comma-separated string of valid field names. Invalid or misspelled fields may cause incomplete or failed responses.
  • API Authentication Errors: Ensure that the API token and secret are correctly configured and have sufficient permissions.
  • Filter Parsing Errors: Although not applicable for the "Get" operation, if filters are used elsewhere, invalid JSON in filter parameters will cause errors.
  • Network Issues: Connectivity problems will result in network errors; check firewall and internet access.
  • Error Messages: The node surfaces API error messages prefixed with "OnOffice API error:" and network issues with "Network error:". Review these messages for troubleshooting.

Links and References

Discussion