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 estate record by its ID. This is useful in scenarios where you need to fetch specific property details from your OnOffice database, such as when displaying property information in a workflow or syncing estate data with other systems.

Practical examples include:

  • Fetching an estate's details to display in a CRM or dashboard.
  • Retrieving specific fields of an estate for reporting or analysis.
  • Using the estate data as input for further automation steps like notifications or document generation.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve.
Fields Comma-separated list of estate fields to return (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 records containing the requested estate fields.
  • total (optional): Total number of records matching the query (present mainly in multi-record queries).
  • message (optional): Status message returned by the API.

Example output JSON 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/latest/api.php is required.

Troubleshooting

  • Invalid JSON in Fields or Filter: If the fields or any filter parameters are malformed JSON, the node throws an error indicating invalid JSON. Ensure these inputs are correctly formatted.
  • Missing or Incorrect ID: The ID property is mandatory for the get operation. Omitting it or providing an incorrect ID will cause the API to return an error.
  • API Authentication Errors: If the API token or secret is invalid or missing, the node will fail with an authentication error. Verify that the API credentials are correctly configured.
  • Network Issues: Network connectivity problems will result in network error messages. Check your internet connection and firewall settings.
  • API Errors: The node surfaces API error messages returned by OnOffice. Review the message for clues, such as permission issues or invalid parameters.

Links and References

Discussion