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

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

Alerts

Security Area:

  • "Send Alerts" – Insert

URL(s):

  • POST api/v5/SendAlert
    • Send the alert as a JSON object in the request body (see the examples below).
    • SchoolCode is required
    • To send an alert to a specific account, include RecipientID and RecipientType.
    • To send an alert about a student (for example, an Action Alert for parent approval), include StudentID or StudentNumber and leave RecipientID out. Every parent account with access to the student is notified.
    • RecipientType is required and must be a valid value even when sending an alert about a student.
    • Comment is required.
    • PageID will link the Alert to a specific page.
    • The alert is created under the vendor’s product name. The response echoes the request; it does not include an alert ID.
    • Errors return HTTP 500 with one of these messages: “A school code must be specified.”, “Invalid Recipient or No Student Specified”, “A comment must be specified.”, “Invalid Recipient Type. Type must be User, Teacher, Student, or Parent”, or “Invalid Alert Type”.

Field Documentation:

NameTable.ColumnDatatypeDescription
SchoolCodeDAA.SCintAeries School Code
StudentNumber—longStudent Number. Used only to look up the StudentID when StudentID isn’t sent; it is not stored.
StudentIDDAA.IDlongPermanent ID
OtherID—stringAccepted but not currently used.
RecipientIDDAA.RIDlongRecipient ID - Aeries Account ID, depending on User Type is matched to:
  • UGN
  • PWA/PWS
RecipientTypeDAA.RTYstringUser Type
  • Parent
  • Student
  • Teacher
  • User
REQUIRED. Values are case-sensitive.
PageIDDAA.PGstringPage ID - See Documentation
CommentDAM.CCOstringREQUIRED. The alert text.
AlertTypeDAA.TYstring"Alert", "ActionAlert", or "Report" (case-sensitive). Stored as a number: 1 = Alert, 2 = ActionAlert, 3 = Report.


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"

}