...
GET /ssp/api/1/person/{id}/earlyAlert
Security
PERSON_EARLY_ALERT_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
...
GET /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_READ
Returns
EarlyAlert
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"courseName" : "MTH-100",
"courseTitle" : "Introduction to Math",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"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"} |
...
The {id} in the URL for Early Alert creation can either be an existing Person ID in UUID syntax, or it can be the school's legacy School ID (the school-assigned identifier for the student) for an existing Person.
Security
PERSON_EARLY_ALERT_WRITE
Sample Post
| Code Block |
|---|
{"courseName" : "MTH-101",
"courseTitle" : "Concepts of Math",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"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.",
"sendEmailToStudent" : true} |
...
PUT /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"courseName" : "MTH-100",
"courseTitle" : "Introduction to Math",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"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 /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_DELETE
Returns
| Code Block |
|---|
{"success" : "true"} |
...