OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Update operation, it updates an existing address record in the OnOffice system by sending new data for that address identified by its ID.

Common scenarios where this node is useful include:

  • Keeping address records up-to-date in a real estate CRM or property management system.
  • Automating updates of contact information related to properties.
  • Synchronizing address changes from other systems into OnOffice.

Example: You have a workflow that receives updated contact details for a property’s address and uses this node to update the corresponding address record in OnOffice automatically.

Properties

Name Meaning
ID The unique identifier of the address record to update. This is required to specify which address to modify.
Data A JSON object containing the fields and values to update on the address record. This should be valid JSON representing the new data for the address.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the Update operation on Address, the output JSON has the following structure:

  • success: Boolean indicating if the update was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "update".
  • data: The updated address data returned from the API.
  • message: A status message from the API about the update operation.

If the API returns multiple records (not typical for update), those are included under data.records. Otherwise, the updated single record data is under data.

No binary data output is produced by this node.

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.
  • The node depends on helper functions for formatting fields, generating request IDs, and creating HMAC signatures (from bundled utils).

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Invalid ID: Providing an empty or incorrect ID will cause the API to fail to find the record to update.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API credentials and the correctness of the data sent.
  • Network Issues: Network errors during the HTTP request result in a "Network error" message. Verify network connectivity and API endpoint availability.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error indicating so.
  • Filter Parsing Errors: Although not relevant for update, other operations using filters require valid JSON; invalid filter JSON causes errors.

To resolve issues:

  • Validate all JSON inputs before running the node.
  • Confirm the ID exists in OnOffice.
  • Check API credentials and permissions.
  • Review the API response messages for specific error details.

Links and References

Discussion