Librus icon

Librus

Read data from Librus Synergia (unofficial)

Homework → Get Message

AI-generated

Summary

Retrieve detailed information about a specific homework message by its identifier.

Inputs

  • From — Optional start date to filter the homework messages, in YYYY-MM-DD format.
  • To — Optional end date to filter the homework messages, in YYYY-MM-DD format.
  • Custom method name — Optional override to specify a custom underlying method name for advanced usage (e.g. to call a different API method).

Output shape

a single JSON object representing the homework message matching the provided homeworkId, including its details; or an empty array if no message is found.

The operation expects a 'homeworkId' parameter (not shown in the UI properties above but inferred from source) to identify which homework message to retrieve. The 'From' and 'To' parameters are optional date filters but seem not to affect this specific 'getMessage' call based on the source. If a custom method name is specified, it will override the internal method called on the API client. The result is returned as a single JSON object with an added 'id' field for consistency.

Examples

Example 1: Retrieve details for a specific homework assignment by ID

Set the 'Homework' resource and 'Get Message' operation, specify the 'homeworkId' of the homework message to retrieve. Optionally set 'From' and 'To' date filters and/or a custom method name to customize the API call.

Discussion