Actions14
Overview
This node integrates with the onOffice API to perform various operations related to real estate data management. Specifically, for the Search resource with the Address operation, it allows users to search addresses stored in the onOffice system using either simple keyword searches or advanced criteria.
Typical use cases include:
- Quickly finding address records by entering keywords such as names or phone numbers.
- Performing detailed filtered searches based on multiple criteria like city, postal code, or contact details.
- Limiting the number of results returned to manage large datasets efficiently.
For example, a user might want to find all active addresses in a specific city or search for contacts by partial phone numbers.
Properties
| Name | Meaning |
|---|---|
| Search Type | Type of search to perform: - Simple: Search with simple keywords - Advanced: Search with advanced criteria |
| Keywords | (Simple search only) The keywords string used to search addresses |
| Search Criteria | (Advanced search only) A collection of detailed criteria including: - Minimum Price (for estates, not applicable here) - Maximum Price (for estates, not applicable here) - City: City to search in - Postal Code: Postal code to search in - Estate Type (for estates, not applicable here) - Status (for estates, not applicable here) |
| Limit | Maximum number of results to return |
Note: For the Address resource and Search operation, only relevant criteria from the advanced search are used (e.g., city, postal code). Some criteria listed are estate-specific and do not apply here.
Output
The node outputs an array of JSON objects representing the matched address records. Each output item contains:
- The address record fields as returned by the onOffice API, such as customer number, name, phone, email, street, postal code, city, country, and user information.
- An additional property
resourceTypeset to"search"indicating the type of resource returned.
If no results are found or the response cannot be parsed, the node returns a success message with the raw API response.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the onOffice API.
- The node uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.
- HTTP POST requests are made to the onOffice stable API endpoint (
https://api.onoffice.de/api/stable/api.php).
Troubleshooting
- No credentials provided: The node will throw an error if the required API authentication credentials are missing. Ensure that valid API credentials are configured in n8n.
- Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error indicating invalid input.
- API errors: If the onOffice API returns an error status code, the node surfaces the error message. Check the API token and secret validity and ensure the requested data exists.
- No results found: The node returns a success message with no records if the search yields no matches.
- Parsing errors: If the API response structure changes or is unexpected, the node may fail to parse results properly.
To resolve issues:
- Verify credentials and permissions.
- Confirm correct property values and filters.
- Review API limits and quotas.
- Enable "Continue On Fail" to handle errors gracefully in workflows.