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 in the OnOffice system by specifying its ID and providing new data fields.

Typical use cases include:

  • Synchronizing address information from other systems into OnOffice.
  • Correcting or enriching address details for contacts related to estates.
  • Automating updates of address records based on external triggers or workflows.

For example, if a contact's address changes, this node can be used to update that address record automatically without manual intervention.

Properties

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

Output

The node outputs a JSON array where each item corresponds to an input item processed. For the Update Address operation, the output JSON structure includes:

  • success: Boolean indicating whether 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 response.

If the API call fails and "Continue On Fail" is enabled, the output will contain an error object with:

  • success: false
  • error: Error message describing what went wrong.
  • resourceType and operation for context.

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: https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary before using this node.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the "Data" field is malformed, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Invalid ID: Providing an incorrect or non-existent address ID will cause the API to return an error. Verify the ID exists in OnOffice.
  • API errors: Errors returned from the OnOffice API are surfaced with messages like "OnOffice API error: ". Check the API token validity, permissions, and request parameters.
  • Network issues: Network connectivity problems result in errors like "Network error: ". Confirm network access to the OnOffice API endpoint.
  • Filter parsing errors (not applicable directly to update but relevant for other operations): Filters must be valid JSON when used.

Enabling "Continue On Fail" allows workflows to proceed even if some items fail, capturing error details in the output.

Links and References

Discussion