Request examples

All data since creation

The request made for the endpoint /data as below would return all data integrated in the org_id school since its creation, regardless of the date of updating its records.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}

🚧

This model is not recommended if the school has many users or a history longer than 6 months

min_date

Using the parameter min_date as in the example below (min_date=2020/09/05+00:00:00), the request will return only the records added, modified or removed from the school from the date informed in the parameter.

Example: [https://apihub.educacional.com/manager/v1/data/{org_id}?min_date=2020/09/05 00:00:00](https://apihub.educacional.com/maneger/v1/data/{org_id}?min_date=2020/09/05 00:00:00)

max_date

Using the parameter max_date as in the example below (max_date=2020/12/31+00:00:00), the request will only return records added, modified or removed from the school until the date entered in the parameter.

Example: [https://apihub.educacional.com/manager/v1/data/{org_id}?max_date=2020/12/31 00:00:00](https://apihub.educacional.com/maneger/v1/data/{org_id}?max_date=2020/12/31 00:00:00)

Time interval

If the two parameters min_date and max_date be reported together, the return data will only be records added, modified or removed between the days reported. Joining the two examples, the data returned will be from the records added, modified or removed between 2020/05/09 to 00:00:00 and 2020/12/09 to 00:00:00.

Example: [https://apihub.educacional.com/manager/v1/data/{org_id}?min_date=2020/09/05 00:00:00&max_date=2020/12/05 00:00:00](https://apihub.educacional.com/maneger/v1/data/{org_id}?min_date=2020/09/05 00:00:00&max_date=2020/12/05 00:00:00)

event

The request made for the endpoint /data as below it would return all data referring to the insert operation, that is, data added to the institution.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}?event=insert

To return only the insert and update data.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}?event=insert,update

only

Using the parameter only for the requisition /date, we can choose which objects will be returned, the example below will return only the records added, modified or removed from the relationship between class and student.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}?only=turmaAluno

To return only the records added, modified or removed from the list of section and students, and the term.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}?only=turmaAluno,periodo

execpt

The parameter except it works in the same way as only, but instead of choosing which objects will be returned, with the exception it is possible to exclude the object. The example below will only return records added, modified or removed from all objects, except for the term.

Example: https://apihub.educacional.com/manager/v1/data/{org_id}?except=periodo