OnOffice

Consume OnOffice API

Actions12

Address → Create

AI-generated

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 Create operation, it allows users to create a new address record in the OnOffice system by providing the necessary address data in JSON format.

Common scenarios where this node is beneficial include:

  • Automating the addition of new contact addresses into a real estate management system.
  • Integrating form submissions or CRM data to automatically create address entries.
  • Synchronizing external address data sources with OnOffice.

Example: A user collects new client contact information via a web form and uses this node to create corresponding address records in OnOffice automatically.

Properties

Name Meaning
Data JSON object containing the details of the address to create. This should include all required fields as per OnOffice API for an address record.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "create".
  • data: The response data from OnOffice API representing the created address record.
  • message: A status message returned by the API.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": {
    /* Created address record details */
  },
  "message": "Record created successfully"
}

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node expects these credentials to be configured in n8n under a generic API authentication credential.
  • Network access to https://api.onoffice.de/api/v1 is required.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the Data field is malformed, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Authentication errors: If the API token or secret are missing or invalid, requests will fail. Verify that the API credentials are correctly set up.
  • OnOffice API errors: The node surfaces error messages returned by the OnOffice API. Common issues might include missing required fields or invalid data formats. Review the error message for guidance.
  • Network errors: Connectivity issues will result in network error messages. Check your internet connection and firewall settings.

Links and References

Discussion