Get All Early Alert Referrals
GET /ssp/api/1/reference/earlyAlertReferral
Security
SERVICE_REFERENCE_READ
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
{"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",
"acronym" : "FAO"
"name" : "Financial Aid Office",
"description" : "Financial Aid Office.",
"sortOrder" : 1},
{"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",
"acronym" : "IN"
"name" : "Instructor for Course",
"description" : "Instructor for Course.",
"sortOrder" : 2},
...
]
}
Get an Early Alert Referral
GET /ssp/api/1/reference/earlyAlertReferral/{id}
Security
SERVICE_REFERENCE_READ
Returns
EarlyAlertReferral
{"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",
"acronym" : "FAO"
"name" : "Financial Aid Office",
"description" : "Financial Aid Office.",
"sortOrder" : 1}
Create an Early Alert Referral
POST /ssp/api/1/reference/earlyAlertReferral
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"acronym" : "RC",
"name" : "Reading Center",
"description" : "Reading Center."}
Returns
Outcome
{"id" : "73bfcb09-95f5-4f52-87cf-76277193d51c",
"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",
"acronym" : "RC",
"name" : "Reading Center",
"description" : "Reading Center.",
"sortOrder" : 3}
Save an Early Alert Referral
PUT /ssp/api/1/reference/earlyAlertReferral/{id}
Security
SERVICE_REFERENCE_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",
"acronym" : "FAO",
"name" : "Financial Aid Office",
"description" : "Financial Aid Office.",
"sortOrder" : 1}
Returns
EarlyAlertReferral
{"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",
"acronym" : "FAO",
"name" : "Financial Aid Office",
"description" : "Financial Aid Office.",
"sortOrder" : 1}
Delete an Early Alert Referral
DELETE /ssp/api/1/reference/earlyAlertReferral/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}