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" resource with the "Update" operation allows users to update existing address records in the OnOffice system by specifying the record ID and the new data.

Common scenarios for this node include:

  • Updating contact information or location details of an address associated with a real estate object.
  • Synchronizing address data from other systems into OnOffice.
  • Automating updates to address records based on external triggers or workflows.

For example, if a tenant moves or changes their contact details, this node can be used to update the corresponding address record 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 state of 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 involved, 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"
}

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 for successful operation.

Troubleshooting

  • Invalid JSON in Data property: If the "Data" field 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 ID will likely cause the API to return an error. Verify that the ID corresponds to an existing address record.
  • API errors: Errors returned from the OnOffice API are surfaced with messages like "OnOffice API error: ". Check the API documentation or your API usage limits.
  • Network issues: Network connectivity problems result in errors such as "Network error: ". Confirm network access and API endpoint availability.
  • Unsupported operations or resources: Attempting unsupported combinations of resource and operation will throw errors indicating the resource or operation is not supported.

Links and References

Discussion