OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The "Relation" resource with the "Get" operation allows users to retrieve detailed information about a specific relation by its ID. This is useful in scenarios where you need to fetch the connection details between an estate and a contact, such as identifying the owner, tenant, or other types of relationships.

Practical examples:

  • Retrieve the owner information linked to a particular estate.
  • Fetch the tenant details associated with a property.
  • Get contact information related to an estate for communication or record-keeping.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete.
Fields Comma-separated list of fields to return from the relation record. Default: id,type,estateid,addressid

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "get".
  • data: An array of records representing the retrieved relation(s), each containing the requested fields.
  • total (optional): Total count of records when applicable.
  • message (optional): Status message from the API.

Example output snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "get",
  "data": [
    {
      "id": "123",
      "type": "owner",
      "estateid": "456",
      "addressid": "789"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active OnOffice API credential with an API token and secret.
  • The node makes HTTP POST requests to the OnOffice stable API endpoint (https://api.onoffice.de/api/stable/api.php).
  • Proper configuration of the API credentials within n8n is necessary for authentication.

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is incorrect, the API may return an error or empty data. Verify the ID before use.
  • Malformed Fields Parameter: The Fields input must be a comma-separated string of valid field names. Incorrect field names might cause incomplete or failed responses.
  • API Authentication Errors: Ensure that the API token and secret are correctly configured; otherwise, authentication will fail.
  • Network Issues: Network connectivity problems can cause request failures. Check your internet connection and firewall settings.
  • JSON Parsing Errors: Although not directly relevant for the "Get" operation, other operations require valid JSON inputs. Invalid JSON will throw errors.

Common error messages:

  • "OnOffice API error: <message>": Indicates an error response from the OnOffice API. Review the message for details.
  • "Network error: <message>": Indicates network-level issues preventing the request.

Links and References

Discussion