OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. The "Address" resource's "Update" operation allows users to update existing address records by specifying the record ID and the new data in JSON format.

Common scenarios include:

  • Updating contact details or location information of an address associated with a real estate object.
  • Correcting or enriching address data without creating a new record.
  • Automating updates to address records based on external triggers or workflows.

For example, if a tenant moves or their contact information changes, this node can be used 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 record 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 data for the address record.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating whether the update was successful.
  • resourceType: The resource type affected, here it will be "address".
  • operation: The operation performed, here "update".
  • data: Contains the updated address data returned from the API.
  • message: A status message from the API about the update operation.

Example output JSON:

{
  "success": true,
  "resourceType": "address",
  "operation": "update",
  "data": {
    /* updated address record fields */
  },
  "message": "Record updated successfully"
}

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential and secret).
  • Uses HTTPS POST requests to the OnOffice API endpoint https://api.onoffice.de/api/v1.
  • Relies on helper functions to generate request IDs, create request bodies, and sign requests with HMAC signatures.

Troubleshooting

  • Invalid JSON in Data property: If the "Data" field contains invalid JSON, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Invalid ID: Providing an incorrect or non-existent ID will cause the API to return an error. Verify the ID corresponds to an existing address record.
  • API Authentication errors: Missing or incorrect API token/secret will result in authentication failures. Check that the credentials are correctly set up in n8n.
  • Network errors: Connectivity issues or API downtime will cause network errors. Retry later or check network settings.
  • API error messages: The node surfaces API error messages if the OnOffice API returns an error status. Review the message for details on what went wrong.

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

Links and References

Discussion