Actions55
- Client Actions
- General Actions
- Mission Actions
- Agent Actions
- Invoice Actions
- Contact Actions
- Alert Actions
- Walter Actions
- Notification Actions
- Webhook Actions
- Route Actions
- Export Actions
Overview
This node interacts with the Everest Transport Management System (TMS) to retrieve multiple agent records based on various filtering and pagination options. It is useful in scenarios where you need to list agents with specific criteria such as availability, activity status, or mission participation within a certain date range.
Practical examples include:
- Fetching all active and available agents for scheduling new missions.
- Retrieving agents who have had missions within a specific timeframe for reporting purposes.
- Searching agents by name, email, or phone to quickly find relevant personnel.
Properties
| Name | Meaning |
|---|---|
| Options | A collection of optional filters and parameters to customize the query: |
| - Limit | Maximum number of agent results to return (default 50). |
| - Limit Start | Starting offset for pagination (0-based index, default 0). |
| - Search | Search term to filter agents by name, email, or phone. |
| - Available Only | Boolean flag to filter only agents currently available. |
| - Active Only | Boolean flag to filter only agents with active accounts. |
| - Start Date From | Filter agents who had missions starting from this date/time (Europe/Paris timezone). |
| - Start Date To | Filter agents who had missions until this date/time (Europe/Paris timezone). |
| - With Missions Only | Boolean flag to return only agents who have missions, can be used without date filters. |
Output
The node outputs an array of JSON objects representing agents matching the specified criteria. Each object contains agent details such as name, contact information, status, availability, and mission-related data depending on the API response.
If binary data were involved (not indicated here), it would typically represent files or attachments related to agents, but this operation focuses on JSON data output.
Dependencies
- Requires an API key credential to authenticate with the Everest TMS API.
- The node depends on the Everest TMS backend services being accessible.
- Timezone considerations: date filters use Europe/Paris timezone for mission date filtering.
Troubleshooting
- Empty Results: If no agents are returned, verify that your filters (search terms, date ranges, flags) are correct and that there are agents matching those criteria in the system.
- Pagination Issues: Ensure
LimitandLimit Startvalues are set appropriately to avoid missing data or excessive requests. - Date Filtering: Incorrect date formats or timezones may cause unexpected filtering results; ensure dates follow the expected format and timezone.
- API Errors: Authentication failures or network issues will result in errors; confirm that the API key is valid and the Everest service is reachable.
- Continue On Fail: If enabled, errors per item will be captured in the output instead of stopping execution, which helps in batch processing scenarios.
Links and References
- Everest TMS Official Documentation (replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- General REST API best practices for pagination and filtering