OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node interacts with the OnOffice API to manage "Relation" resources, specifically allowing you to retrieve or delete a relation by its ID. Relations represent connections between estates and addresses (contacts) in the OnOffice system. This node is useful when you need to fetch detailed information about a specific relation or remove an existing relation from your OnOffice data.

Practical examples:

  • Retrieve details of a particular relation to display or process further.
  • Delete a relation that is no longer valid or needed in your real estate management workflow.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete.
Fields Comma-separated list of fields to return for the relation (e.g., id,type,estateid,addressid).

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The performed operation, either "get" or "delete".
  • data: For a successful "get" operation, this contains the retrieved relation record(s) with the requested fields.
  • message: For "delete" operations or some other responses, a message string from the API.
  • total: (optional) Total count of records returned, present when multiple records are fetched.

No binary data is output by this node.

Example output for a successful get operation:

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

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Invalid JSON in Filters or Data: When using filters or data input fields, ensure the JSON is well-formed. Errors will indicate invalid JSON.
  • API Errors: If the API returns an error, the node will throw an error with the message from the API response. Check the API token validity and permissions.
  • Network Issues: Network errors will be reported; verify internet connectivity and API endpoint accessibility.
  • Missing Required Fields: The "Relation ID" is required for "get" and "delete" operations; omitting it will cause errors.

Links and References

Discussion