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" : [],
"earlyAlertSuggestionOtherDescription" : null,
"comment" : "Student is struggling in MTH class and frequently sleeps"},
{"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" : [],
"earlyAlertSuggestionOtherDescription" : null,
"comment" : null},
...
]
Get an Early Alert Reason
GET /ssp/api/1/reference/earlyAlertReason/{id}
Returns
EarlyAlertReason
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1}
Create an Early Alert Reason
POST /ssp/api/1/reference/earlyAlertReason
Sample Post
{"description" : "Low test scores.",
"name" : "Low Test Scores"}
Returns
EarlyAlertReason
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Low Test Scores",
"description" : "Low test scores.",
"sortOrder" : 3}
Save an Early Alert Reason
PUT /ssp/api/1/reference/earlyAlertReason/{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",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1}
Returns
EarlyAlertReason
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Academic Concern",
"description" : "Academic concern",
"sortOrder" : 1}
Delete an Early Alert Reason
DELETE /ssp/api/1/reference/earlyAlertReason/{id}
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}