Get All Early Alerts for a Person
GET /ssp/api/1/person/{id}/earlyAlert
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
List<EarlyAlert>
[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "MTH-100", "courseTitle" : "Introduction to Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is struggling in MTH class and frequently sleeps", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}, {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "ENGL-100", "courseTitle" : "Introduction to English", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "839aee41-c882-482d-ba1c-695eae44976a"}, {"id" : "49300166-ff8a-4707-8c07-9c22d2f2e6d1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "ecd3fd47-90e4-43de-87b6-6e28d4f09455"}, {"id" : "dc35dd0a-5d21-4190-87b2-858bb5b505c9"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : null, "closedDate" : null, "closedById" : null}]
Get an Early Alert
GET /ssp/api/1/person/{id}/earlyAlert/{id}
Returns
EarlyAlert
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "MTH-100", "courseTitle" : "Introduction to Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is struggling in MTH class and frequently sleeps", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Create an Early Alert
POST /ssp/api/1/person/{id}/earlyAlert
Sample Post
{"courseName" : "MTH-101", "courseTitle" : "Concepts of Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is often late to class and isn't prepared.", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Returns
EarlyAlert
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "MTH-101", "courseTitle" : "Concepts of Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is often late to class and isn't prepared.", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Save an Early Alert
PUT /ssp/api/1/person/{id}/earlyAlert/{id}
Sample Post
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "MTH-100", "courseTitle" : "Introduction to Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is struggling in MTH class and frequently sleeps", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Returns
EarlyAlert
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "createdDate" : "1332216000000", "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : "1332216000000", "objectStatus" : "ACTIVE", "courseName" : "MTH-100", "courseTitle" : "Introduction to Math", "emailCC" : "john.smith@university.edu", "campusId" : 1, "earlyAlertReasonIds" : [{"id" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7"}, {"id" : "216a272f-a457-447e-9bc2-72ee5436a8b1"}], "earlyAlertReasonOtherDescription" : null, "earlyAlertSuggestionIds" : [{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"}, {"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}], "earlyAlertSuggestionOtherDescription" : null, "comment" : "Student is struggling in MTH class and frequently sleeps", "closedDate" : "1332216000000", "closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Delete an Early Alert
DELETE /ssp/api/1/person/{id}/earlyAlert/{id}
Returns
{"success" : "true"}
or
{"success" : "false", "message" : "Message when success is false."}