Description
Outreaches are used to populate the outreach drop-down list when responding to the early alert.
Get All Early Alert Outreaches
GET /ssp/api/1/reference/outreachearlyAlertOutreach
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<FacultySuggestion>List<EarlyAlertOutreach>
| Code Block |
|---|
[{"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" : "Phone Call",
"description" : "Phone Call.",
"sortOrder" : 1},
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Email",
"description" : "Email.",
"sortOrder" : 2},
...
] |
Get an Early Alert Outreach
GET /ssp/api/1/reference/outreachearlyAlertOutreach/{id}
Returns
OutreachEarlyAlertOutreach
| Code Block |
|---|
{"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" : "Phone Call",
"description" : "Phone Call.",
"sortOrder" : 1} |
Create an Early Alert Outreach
POST /ssp/api/1/reference/outreachearlyAlertOutreach
Sample Post
| Code Block |
|---|
{"name" : "Letter"
"description" : "Letter."} |
Returns
FacultySuggestionEarlyAlertOutreach
| Code Block |
|---|
{"id" : "73bfcb09-95f5-4f52-87cf-76277193d51c",
"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"createdDate" : "1332216000000",
"modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Letter",
"description" : "Letter.",
"sortOrder" : 3} |
Save an Early Alert Outreach
PUT /ssp/api/1/reference/outreachearlyAlertOutreach/{id}
Sample Post
| Code Block |
|---|
{"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" : "Phone Call",
"description" : "Phone Call.",
"sortOrder" : 1} |
Returns
OutreachEarlyAlertOutreach
| Code Block |
|---|
{"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" : "Phone Call",
"description" : "Phone Call.",
"sortOrder" : 1} |
Delete an Early Alert Outreach
DELETE /ssp/api/1/reference/outreachearlyAlertOutreach/{id}
Returns
| Code Block |
|---|
{"ServiceResponse" : {"success" : "true"}} |
or
| Code Block |
|---|
{"ServiceResponse" :
{"success" : "false",
"message" : "Message when success is false."}} |