Get All Documents for a Person
GET /ssp/api/1/person/{id}/studentdocument
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",
"message":"","results":1,
"rows":
[{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
"createdDate":1347964903568,
"createdBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"modifiedDate":1348220503568,
"modifiedBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"objectStatus":"ACTIVE",
"courseName":"ENG055",
"courseTitle":"College ReadingI",
"courseTermCode":"FA12",
"emailCC":null,
"campusId":"0a640a2a-409d-1271-8140-d10a51770117",
"earlyAlertReasonOtherDescription":null,
"earlyAlertSuggestionOtherDescription":null,
"comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
"personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
"closedDate":null,
"closedById":null,
"closedByName":null,
"noOfResponses":1,
"earlyAlertReasonIds":
[{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Excessive Absences",
"description":"Excessive Absences",
"sortOrder":2}],
"earlyAlertSuggestionIds":
[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Withdraw",
"description":"",
"sortOrder":8}],
"sendEmailToStudent":false}
]
}
Get an Early Alert
GET /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_READ
Returns
EarlyAlert
{"success":"true",
"message":"","results":1,
"rows":
[{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
"createdDate":1347964903568,
"createdBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"modifiedDate":1348220503568,
"modifiedBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"objectStatus":"ACTIVE",
"courseName":"ENG055",
"courseTitle":"College ReadingI",
"courseTermCode":"FA12",
"emailCC":null,
"campusId":"0a640a2a-409d-1271-8140-d10a51770117",
"earlyAlertReasonOtherDescription":null,
"earlyAlertSuggestionOtherDescription":null,
"comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
"personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
"closedDate":null,
"closedById":null,
"closedByName":null,
"noOfResponses":1,
"earlyAlertReasonIds":
[{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Excessive Absences",
"description":"Excessive Absences",
"sortOrder":2}],
"earlyAlertSuggestionIds":
[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Withdraw",
"description":"",
"sortOrder":8}],
"sendEmailToStudent":false}
]
}
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
{"success":"true",
"message":"","results":1,
"rows":
[{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
"createdDate":1347964903568,
"createdBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"modifiedDate":1348220503568,
"modifiedBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"objectStatus":"ACTIVE",
"courseName":"ENG055",
"courseTitle":"College ReadingI",
"courseTermCode":"FA12",
"emailCC":null,
"campusId":"0a640a2a-409d-1271-8140-d10a51770117",
"earlyAlertReasonOtherDescription":null,
"earlyAlertSuggestionOtherDescription":null,
"comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
"personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
"closedDate":null,
"closedById":null,
"closedByName":null,
"noOfResponses":1,
"earlyAlertReasonIds":
[{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Excessive Absences",
"description":"Excessive Absences",
"sortOrder":2}],
"earlyAlertSuggestionIds":
[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Withdraw",
"description":"",
"sortOrder":8}],
"sendEmailToStudent":false}
]
}
Save an Early Alert
PUT /ssp/api/1/person/{id}/earlyAlert/{id}
Security
PERSON_EARLY_ALERT_WRITE
Sample Post
{"success":"true",
"message":"","results":1,
"rows":
[{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
"createdDate":1347964903568,
"createdBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"modifiedDate":1348220503568,
"modifiedBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"objectStatus":"ACTIVE",
"courseName":"ENG055",
"courseTitle":"College ReadingI",
"courseTermCode":"FA12",
"emailCC":null,
"campusId":"0a640a2a-409d-1271-8140-d10a51770117",
"earlyAlertReasonOtherDescription":null,
"earlyAlertSuggestionOtherDescription":null,
"comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
"personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
"closedDate":null,
"closedById":null,
"closedByName":null,
"noOfResponses":1,
"earlyAlertReasonIds":
[{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Excessive Absences",
"description":"Excessive Absences",
"sortOrder":2}],
"earlyAlertSuggestionIds":
[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Withdraw",
"description":"",
"sortOrder":8}],
"sendEmailToStudent":false}
]
}
Returns
EarlyAlert
{"success":"true",
"message":"","results":1,
"rows":
[{"id":"84ace006-1a36-4acc-83a7-2d87abfcf3c2",
"createdDate":1347964903568,
"createdBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"modifiedDate":1348220503568,
"modifiedBy":
{"id":"f02058a4-76e5-4d06-97d2-97d13db0505e",
"firstName":"Demo",
"lastName":"Coach18"},
"objectStatus":"ACTIVE",
"courseName":"ENG055",
"courseTitle":"College ReadingI",
"courseTermCode":"FA12",
"emailCC":null,
"campusId":"0a640a2a-409d-1271-8140-d10a51770117",
"earlyAlertReasonOtherDescription":null,
"earlyAlertSuggestionOtherDescription":null,
"comment":"Do to lack of attendance and low test scores, he should consider withdrawing from this class.",
"personId":"284c2248-87cd-342e-0c77-d36444ea3b9b",
"closedDate":null,
"closedById":null,
"closedByName":null,
"noOfResponses":1,
"earlyAlertReasonIds":
[{"id":"b2d112b8-5056-a51a-8067-1fda2849c3e5",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41","
firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Excessive Absences",
"description":"Excessive Absences",
"sortOrder":2}],
"earlyAlertSuggestionIds":
[{"id":"b2d111ed-5056-a51a-8046-5291453e8720",
"createdDate":1336003200000,
"createdBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"modifiedDate":1336003200000,
"modifiedBy":
{"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Withdraw",
"description":"",
"sortOrder":8}],
"sendEmailToStudent":false}
]
}
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."}