PUT ./ani/periods
It is used to update a period for a school year.
PUT parameters
Name | Value Type | Validation | Details |
---|
sanID | int | Required | The period ID |
name | string | min_length[3] | Name of the period |
shortName | string | min_length[3] | The short version of the name |
isActive | int | | Set the period as active. |
startDate | date | Required, rfc_datetime | Sets the begininngs of the period. |
endDate | date | Required, rfc_datetime | Sets the end of the period. |
Validation
Error Field | Error Code | Error Message |
---|
sanID | 101 | Invalid sanID. |
startDate, endDate | 102 | The date in invalid |
endDate | 103 | The end date must be higher than start date. |
endDate | 104 | The selected period is overlaped with other periods from DB |
startDate & endDate | 105 | The period should be fully included in the selected school year. |
Output example
{
"result": true
}