PUT ./ani/periods

It is used to update a period for a school year.

PUT parameters

NameValue TypeValidationDetails
sanIDintRequiredThe period ID
namestringmin_length[3]Name of the period
shortNamestringmin_length[3]The short version of the name
isActiveintSet the period as active.
startDatedateRequired, rfc_datetimeSets the begininngs of the period.
endDatedateRequired, rfc_datetimeSets the end of the period.

Validation

Error FieldError CodeError Message
sanID101Invalid sanID.
startDate, endDate102The date in invalid
endDate103The end date must be higher than start date.
endDate104The selected period is overlaped with other periods from DB
startDate & endDate105The period should be fully included in the selected school year.

Output example

{
"result": true
}