Description
The Early Alert Routings define any additional parties that are to receive EA communication when an EA is received in the SSP system. These routings are setup by campus and early alert reason.
The routing may define a person to receive the communication, a group (with name and email distribution list), or both.
Get All Early Alert Routings for Campus
GET /ssp/api/1/reference/campus/{id}/earlyAlertRouting
Security
SERVICE_REFERENCE_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/reference/campus/{id}/earlyAlertRouting{id}
Security
SERVICE_REFERENCE_READ
Returns
EarlyAlertRouting
| Code Block |
|---|
{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"createdDate" : 1332216000000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1332216000000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"person" :
{"id" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"firstName" : "Angie",
"lastName" : "Advisor"},
"groupName" : null,
"groupEmail" : null} |
...
POST /ssp/api/1/reference/campus/{id}/earlyAlertRouting
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"person" :
{"id" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"firstName" : "Angie",
"lastName" : "Advisor"},
"groupName" : null,
"groupEmail" : null} |
...
PUT /ssp/api/1/reference/campus/{id}/earlyAlertRouting/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"createdDate" : 1332216000000,
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : 1332216000000,
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"person" :
{"id" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"firstName" : "Angie",
"lastName" : "Advisor"},
"groupName" : null,
"groupEmail" : null} |
...
DELETE /ssp/api/1/reference/campus/{id}/earlyAlertRouting/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...