Note: This feature is in Beta right now. Parent Approvals for Academic Plan are the only supported feature.

This endpoint allows 3d parties to send Alerts and Action Alerts to Parents/Students/Teachers and Users

Alerts

Security Area:

  • "Alerts"

URL(s):

  • api/v5/SendAlert/{alert}
    • SchoolCode is required
    • For Action Alerts the StudentID or StudentNumber should be used
      • Both Parents will receive the Alert
    • For Alerts only the RecipientID is needed
    • PageID will link the Alert to a specific page. 

Field Documentation:

NameTable.ColumnDatatypeDescription
SchoolCodeDAA.SCintAeries School Code
StudentNumberDAA.SNlongStudent Number
StudentIDDAA.IDlongPermanent ID
OtherIDDAA.OIDstringUser-assigned ID
RecipientIDDAA.RIDlongRecipient ID - Aeries Account ID, depending on User Type is matched to:
  • UGN
  • PWA/PWS
RecipientTypeDAA.RTYstringUser Type
  • Parent
  • Student
  • Teacher
  • User
PageIDDAA.PGstringPage ID - See Documentation
CommentDAA.COstringComment
AlertTypeDAA.TYstring"Alert" or "ActionAlert"


Example of an Alert payload:

{
    "SchoolCode":"994",
    "RecipientID":"937",
    "RecipientType":"User",
    "PageId":"100019196",
    "Comment":"Please review the changes",
    "AlertType":"Alert"

}


Example of an ActionAlert payload for Parent Approval of Academic Plan:


{
    "SchoolCode":"994",
    "StudentID":"99400028",
    "RecipientType":"Parent",
    "PageId":"100019196",
    "Comment":"Please approve the changes",
    "AlertType":"ActionAlert"

}