Wedof icon

Wedof

Facilitez-vous la vie avec Wedof !

Actions169

Apprenant → Lister Les Apprenants

AI-generated

Overview

This node operation lists learners (apprenants) from the Wedof platform. It allows filtering learners based on various date ranges and states, such as examination dates, state changes, and other status transitions. Users can specify custom date ranges, sorting options, pagination, and search queries to retrieve a tailored list of learners. This operation is useful for educational institutions or training organizations to manage and monitor learner data efficiently.

Use Case Examples

  1. Retrieve all learners who have updated their state within a custom date range.
  2. List learners filtered by examination start date and sorted in ascending order.
  3. Search for learners with a specific query string and paginate results.

Properties

Name Meaning
Depuis Le Start date for the custom period filter, required when using a custom period.
Jusqu'au End date for the custom period filter, required when using a custom period.
Basé Sur La Date De The date field on which the filtering is based, such as examination date, last state update, or various status transitions.
Recherche Search query string to filter learners by specific criteria.
Tri Par Field name to sort the learners list by.
Ordre Sort order direction, either ascending or descending.
Limite Maximum number of learner results to return.
Page Page number for paginated results.

Output

JSON

  • id - Unique identifier of the learner.
  • name - Name of the learner.
  • email - Email address of the learner.
  • state - Current state or status of the learner.
  • examinationDate - Date when the learner's examination starts.
  • lastUpdate - Timestamp of the last update to the learner's record.

Dependencies

  • Wedof API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access learner data.
  • Verify that the date filters are correctly formatted and valid; invalid dates may cause errors or empty results.
  • Check pagination parameters to avoid requesting pages beyond the available data range, which may result in empty responses.

Links

  • Wedof API Documentation - Official API documentation for Wedof platform, useful for understanding available endpoints and parameters.

Discussion