OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage relations between estates and addresses (contacts). Specifically, the "Create Relation" operation allows users to establish a new relationship linking an estate with an address, defining the type of relation such as owner, tenant, interested party, or contact.

Common scenarios include:

  • Real estate agencies managing property ownership or tenancy by linking estates to contacts.
  • Tracking interested parties for specific properties.
  • Organizing contacts related to estates for communication or record-keeping.

Practical example:

  • Creating a relation where a contact is marked as the owner of a particular estate by providing the estate ID, address ID, and selecting "Owner" as the relation type.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID The unique identifier of the estate involved in the relation (required)
Address ID The unique identifier of the address/contact involved in the relation (required)

Output

The output JSON contains the result of the create operation with the following structure:

  • success: Boolean indicating if the creation was successful (true).
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "create".
  • data: An object containing the newly created relation details, including at least the estate ID, address ID, and relation type.
  • message: A status message returned from the API confirming the creation.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    "estateid": "12345",
    "addressid": "67890",
    "type": "owner"
  },
  "message": "Relation created successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs valid API credentials consisting of an API token and secret for authentication.
  • The node uses HMAC signature generation for secure API requests.
  • Network access to https://api.onoffice.de/api/v1 must be available.

Troubleshooting

  • Invalid JSON in input data: If the input fields like data are malformed JSON, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • Missing required fields: Omitting required parameters such as estateId or addressId will cause errors. Always provide these mandatory fields.
  • API authentication errors: Incorrect or expired API tokens/secrets will lead to authentication failures. Verify credentials in n8n settings.
  • Network issues: Connectivity problems to the OnOffice API endpoint will result in network errors. Check internet connection and firewall settings.
  • API error messages: The node surfaces API error messages when the OnOffice API returns an error status. Review the message for clues and verify request parameters.

Links and References

Discussion