OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. The "Address - Update" operation allows users to update an existing address record by specifying its ID and providing new data in JSON format. This is useful for keeping contact or location information up-to-date within a real estate management workflow.

Practical examples include:

  • Updating the contact details of an address associated with a property.
  • Correcting or adding additional address fields such as email or phone number.
  • Synchronizing address data from external sources into OnOffice.

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. Users must provide valid JSON representing the updated data.

Output

The node outputs a JSON object with the following structure:

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

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "update",
  "data": {
    /* updated address fields */
  },
  "message": "Update successful"
}

No binary data output is produced by this node.

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/latest/api.php is necessary.
  • Proper configuration of the API credentials in n8n is mandatory.

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • Invalid ID: Providing an incorrect or non-existent address ID will likely cause the API to return an error.
  • API Errors: Errors from the OnOffice API are surfaced with messages like "OnOffice API error: ". Check the API token validity and permissions.
  • Network Issues: Network errors result in messages like "Network error: ". Verify internet connectivity and API endpoint accessibility.
  • Filter Parsing: Although not directly relevant to update, other operations use filters that must be valid JSON; otherwise, similar parsing errors occur.

Using the "Continue On Fail" option can help workflows proceed even if some items fail.

Links and References

Discussion