Get All Early Alerts for a Person
GET /ssp/api/1/person/{id}/earlyAlert
Security
PERSON_EARLY_ALERT_READ
Parameters
status : ALL, ACTIVE, INACTIVE
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)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"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",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"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",
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"closedDate" : "1332216000000",
"closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"},
"closedByName" : "Coach Smith"
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"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" : "ENGL-100",
"courseTitle" : "Introduction to English",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"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,
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"closedDate" : null,
"closedById" : null}
"closedByName" : "Coach Smith",}]
}
Get an Early Alert
GET /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_READ
Returns
EarlyAlert
{"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",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"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",
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"closedDate" : "1332216000000",
"closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"
"closedByName" : "Coach Smith",}
Create an Early Alert
POST /ssp/api/1/person/{id}/earlyAlert
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
{"courseName" : "MTH-101",
"courseTitle" : "Concepts of Math",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"earlyAlertReasonOtherDescription" : null,
"earlyAlertSuggestionIds" :
[{"id" : "b04b0b52-c0e8-4cc5-83ba-5252910f012a"},
{"id" : "d0719473-a17a-44e5-8d63-541870b9983e"}],
"earlyAlertSuggestionOtherDescription" : null,
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"comment" : "Student is often late to class and isn't prepared.",
"sendEmailToStudent" : true}
Returns
EarlyAlert
{"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-101",
"courseTitle" : "Concepts of Math",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"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."
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",}
Save an Early Alert
PUT /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_WRITE
Sample Post
{"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",
"courseTermCode" : "FA12",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"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",
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"closedDate" : "1332216000000",
"closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"
"closedByName" : "Coach Smith"}
Returns
EarlyAlert
{"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",
"courseTermCode" : "FA12",
"courseTitle" : "Introduction to Math",
"emailCC" : "john.smith@university.edu",
"campusId" : "3435c2f3-b3c9-4cdc-b35f-2f492557999c",
"earlyAlertReasonId" : "e02521fc-53ca-4fe6-8de7-b2a1fb3d08f7",
"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",
"personId":"fa8d6aeb-7de8-11e2-b865-406c8f22c3ebc",
"closedDate" : "1332216000000",
"closedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"
"closedByName" : "Coach Smith"}
Delete an Early Alert
DELETE /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_DELETE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}