List Corrected Activities

Endpoint used to query and list corrected activities in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/reports/institution/corrected-activities?course_ids=123,456' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "to": 10,
    "total": 100,
    "data": [
      {
        "activity_id": 123,
        "activity_title": "<string>",
        "activity_type": 9,
        "course_id": 456,
        "course_title": "<string>",
        "student_id": 789,
        "student_name": "<string>",
        "student_email": "<string>",
        "responsible_correction_id": 321,
        "responsible_correction_name": "<string>",
        "responsible_correction_email": "<string>",
        "status_correction": "corrected",
        "date_deliverabled": "<string>",
        "date_correction": "<string>",
        "average": 10,
        "weighted_average": "10"
      }
    ],
    "first_page_url": "<string>",
    "last_page_url": "<string>",
    "next_page_url": "<string>",
    "path": "<string>",
    "per_page": 10,
    "prev_page_url": null
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Query)

Parameter	Type	Description	Required
course_ids	string	Example of query by course IDs “12321,12321,321231”.	No
school_ids	string	Example of query by school IDs “escola_id1, escola_id2”.	No
activity_ids	string	Activity IDs for filtering. Example: atividade_id1, atividade_id2.	No
activity_type	int	Activity type. Accepts only the following values: 9: Test, 10: Deliverable.	No
student_ids	string	ID of the user with a student profile.	No
responsible_ids	string	IDs of those responsible for correcting the activities. Example: resp_id1, resp_id2.	No
status	string	Correction status. Possible values: delivered: Activity delivered. correcting: Activity in correction process. corrected: Activity corrected.	No
start_date_deliverabled	string	Start date for the delivery of activities.	No
end_date_deliverabled	string	End date for the delivery of activities.	No
order_by_column	string	Specifies the column by which the results will be ordered.	No
order_by_direction	string	Sorting direction. Accepts only the values: asc: Ascending. desc: Descending.	No

---

Response description

Key	Type	Description
data	object	Contains the paginated list of corrected activities.
data.current_page	number	Current page of the list.
data.from	number	Index of the first item on the current page.
data.last_page	number	Total number of available pages.
data.to	number	Index of the last item on the current page.
data.total	number	Total number of corrected activities listed.
data.data	array	List of corrected activities.
data.data.activity_id	number	Fictitious identifier of the activity.
data.data.activity_title	string	Activity title.
data.data.activity_type	number	Activity type.
data.data.course_id	number	Fictitious identifier of the associated course.
data.data.course_title	string	Course title.
data.data.student_id	number	Fictitious identifier of the student.
data.data.student_name	string	Fictitious name of the student.
data.data.student_email	string	Fictitious email of the student.
data.data.responsible_correction_id	number	Identifier of the person responsible for the correction.
data.data.responsible_correction_name	string	Name of the person responsible for the correction.
data.data.responsible_correction_email	string	Email of the person responsible for the correction.
data.data.status_correction	string	Correction status.
data.data.date_deliverabled	string	Date of delivery of the activity.
data.data.date_correction	string	Date of correction of the activity.
data.data.average	number	Average obtained by the student.
data.data.weighted_average	string	Weighted average of the activity.
data.first_page_url	string	URL of the first page of the list.
data.last_page_url	string	URL of the last page of the list.
data.next_page_url	string	URL of the next page of the list.
data.path	string	Base URL of the API endpoint.
data.per_page	number	Quantity of items per page.
data.prev_page_url	string	URL of the previous page.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.