Actions30
- Accommodations API Actions
- Administrations API Actions
- Contacts API Actions
- Invoices API Actions
- Price Calculation API Actions
- Rates API Actions
- Reservations API Actions
- Timezones API Actions
Overview
This node interacts with the Starfish API specifically for the CampingCare and HotelCare systems, focusing on the Administrations API to retrieve administration data. It allows users to fetch a list of administrations with options to include additional related data such as accommodations, age tables, media, meta information, and translations. Users can filter, sort, and paginate the results, or request only the total count of administrations. This node is useful for scenarios where detailed or summarized administration data is needed for further processing or reporting within an automation workflow.
Use Case Examples
- Retrieve a paginated list of administrations including accommodation and media details for reporting purposes.
- Fetch only the total count of administrations matching a search term to monitor system usage.
- Get administrations sorted in ascending order with specific offset and limit for batch processing.
Properties
| Name | Meaning |
|---|---|
| Count | Whether to return only the total count of administrations instead of full details. |
| Get Accommodations | Whether to include accommodation data in the response. |
| Get Age Tables | Whether to include age table information in the response. |
| Get Media | Whether to include media information in the response. |
| Get Meta | Whether to include meta information in the response. |
| Translations | Whether to include translations in the response. |
| Limit | Maximum number of administrations to return, minimum value is 1. |
| Offset | Number of items to skip before starting to collect results. |
| Order | Sorting order of the returned administrations; can be none, ascending, or descending. |
| Search | Filter administrations by ID or name with partial matches allowed. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy, and timeout. |
Output
JSON
administrations- Array of administration objects returned from the API, containing details as per requested options.totalCount- Total count of administrations when 'Count' option is enabled.
Dependencies
- Requires an API key credential for authentication with the Starfish API.
Troubleshooting
- Common issues include authentication failures due to invalid or missing API key credentials. Ensure the API key is correctly configured in the node credentials.
- Network issues such as proxy misconfiguration or SSL certificate validation failures can cause request errors. Verify proxy settings and consider enabling 'Ignore SSL Issues' if necessary.
- Invalid parameter values such as negative limits or offsets below zero may cause errors. Ensure numeric inputs meet the minimum value requirements.