Referral Sources identify how the student was referred in for advising services.
Get All Referral Sources
GET /ssp/api/1/reference/referralSource
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/referralSource/{id}
Security
SERVICE_REFERENCE_READ
Returns
ReferralSource
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Campus Police",
"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Campus Police",
"objectStatus" : "ACTIVE"} |
...
POST /ssp/api/1/reference/referralSource
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"description" : "Campus Police",
"name" : "Campus Police"} |
...
PUT /ssp/api/1/reference/referralSource/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Campus Police",
"id" : "a8c83fd4-ee33-46ee-8d89-9b2956696f37",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Campus Police",
"objectStatus" : "ACTIVE"} |
...
DELETE /ssp/api/1/reference/referralSource/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...