Term
- Term entity object
{
"title": "Ano 2020", // Title of the period
"code": "2020", // Period code (single and without spaces)
"start": "01/01/2020", // Start date (no hours)
"end": "31/12/2020", // End date (no hours)
"status": "active" // Period status (active | inactive)
}
To see: data dictionary
Status
Indicate which period is active
active | Active period |
---|---|
inactive | Inactive period |
Example
Creation
List of periods created in the institution
{
"typ": "insert", // event action identifier (insert, update and delete)
"obj": {
"term": [
{
"title": "Ano 2020",
"code": "2020",
"start": "01/01/2020",
"end": "31/12/2020",
"status": "active"
},
{
"title": "Ano 2021",
"code": "2021",
"start": "01/01/2021",
"end": "31/12/2021",
"status": "inactive"
}
],
...
}
}
Update
Disabling 2020 period to activate new school year period
- Send only the code
- Only the active period can be sent, if there is another active one, it will be automatically disabled
Only one period can be active
{
"typ": "update", // event action identifier (insert, update and delete)
"obj": {
"periodo": [
{
"codigo": "2020",
"status": "inactive"
},
{
"codigo": "2021",
"status": "active"
}
],
...
}
}
Deletion
Remove period
{
"typ": "update", // Event action identifier (insert, update and delete)
"obj": {
"periodo": [
{
"codigo": "2020"
},
{
"codigo": "2021"
}
],
...
}
}