OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node interacts with the OnOffice API to retrieve or manipulate IDs related to relations between estates and addresses. Specifically, for the "IDs From Relation" resource with the "Get" operation, it fetches either estate IDs related to a given address or address IDs related to a given estate based on a specified relation type.

Common scenarios include:

  • Finding all addresses associated with a particular estate (e.g., owners, tenants).
  • Finding all estates linked to a specific address/contact.
  • Filtering relations by type such as Owner, Tenant, Interested Party, or Contact.

Practical example:

  • You have an estate ID and want to get all tenant addresses related to that estate.
  • You have an address ID and want to find all estates where this address is listed as an interested party.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact.
ID Type Whether to find estates from an address or addresses from an estate. Options: Estate, Address.
ID The ID of the estate or address to find relations for (string).

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource used ("idsfromrelation").
  • operation: The operation performed ("get").
  • data: An array of records representing the related IDs found.
  • total (optional): Total count of related records if available.
  • status / message: Status messages from the API response.
  • rawResponse: The full raw API response for debugging purposes.

The node does not output binary data.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Requires proper configuration of the API credentials in n8n.

Troubleshooting

  • Invalid JSON Data: If input JSON data is malformed (for other operations), the node throws an error. Ensure JSON inputs are valid.
  • API Request Failed: Network issues or invalid credentials can cause request failures. Verify API credentials and network connectivity.
  • Unsupported Resource or Operation: Using unsupported combinations will throw errors. Confirm the resource is "idsfromrelation" and operation is "get".
  • Empty Results: If no related IDs are found, the data array will be empty. Check that the provided ID and relation type are correct.
  • Permission Issues: API token might lack permissions for requested data; verify API user rights.

Links and References

Discussion