Everest icon

Everest

Interact with Everest TMS (Transport Management System)

Overview

This node integrates with the Everest Transport Management System (TMS) to retrieve multiple client records based on various filtering and pagination options. It is useful in scenarios where you need to fetch a list of clients, optionally filtered by search terms, date ranges related to their missions, or whether they have any missions at all.

Practical examples include:

  • Retrieving a paginated list of clients for reporting or synchronization purposes.
  • Filtering clients who had missions within a specific timeframe to analyze activity.
  • Searching clients by name or other attributes using a search term.
  • Getting only clients that currently have missions assigned.

Properties

Name Meaning
Options A collection of optional filters and pagination settings:
- Limit Maximum number of client results to return.
- Limit Start Starting offset index for pagination (0-based).
- Search Search term to filter clients by matching text.
- Start Date From Filter clients who had missions starting from this date/time (Europe/Paris timezone).
- Start Date To Filter clients who had missions until this date/time (Europe/Paris timezone).
- With Missions Only If true, returns only clients who have missions, regardless of date filters.

Output

The node outputs an array of JSON objects representing clients. Each object contains client data fields as returned by the Everest TMS API. The exact structure depends on the API response but typically includes client identifiers, names, contact details, and mission-related metadata if applicable.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Everest TMS API.
  • The node uses internal helper functions to make authenticated POST requests to the Everest API endpoints.
  • Timezone for date filters is Europe/Paris, so date inputs should be provided accordingly.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid date formats or out-of-range values for date filters may result in errors or empty results.
    • Pagination parameters (limit and limit start) must be non-negative integers; otherwise, the API might reject the request.
    • Using the "With Missions Only" option without proper date filters might yield unexpected results if no clients currently have missions.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on input parameters suggest checking the format and types of the provided options.
    • Network or API downtime errors require retrying later or checking network connectivity.

Links and References

Discussion