OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage relations between estates and addresses (contacts). Specifically, the Relation - Create 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:

  • Associating a property (estate) with its owner or tenant.
  • Linking contacts to properties for communication or record-keeping.
  • Managing interested parties related to real estate listings.

Practical example: A real estate agent can use this node to create a "Tenant" relation between a rental property and a tenant's contact information stored in the system, enabling automated workflows that notify tenants about updates or rent payments.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID ID of the estate for which the relation is being created
Address ID ID of the address (contact) involved in the relation

Output

The node outputs JSON data describing the result of the create operation. The structure includes:

  • success: Boolean indicating if the creation was successful.
  • resourceType: Always "relation" for this operation.
  • operation: Always "create" for this operation.
  • data: Contains the newly created relation details returned by the API.
  • message: A status message from the API confirming the creation.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    "id": "12345",
    "type": "tenant",
    "estateid": "estate_6789",
    "addressid": "address_9876"
  },
  "message": "Relation created successfully"
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs valid API credentials including 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/latest/api.php must be available.

Troubleshooting

  • Invalid JSON in Data Fields: If the input JSON for any data field is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • API Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the API token and secret are correctly configured.
  • Filter Parsing Errors: When using filters in other operations, invalid JSON filters will cause errors. Make sure filter JSON is valid.
  • Network Issues: Network connectivity problems will result in network error messages. Check internet connection and API endpoint accessibility.
  • Unsupported Resource or Operation: Attempting unsupported resource-operation combinations will throw descriptive errors. Confirm that the selected resource and operation are supported.

Links and References

Discussion