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)
Returns
List<ReferralSource>
{"success" : "true",
"results" : "100",
"rows" :
[{"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"},
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Student Conduct",
"id" : "55aebdf7-466b-49c4-a08c-6e01eaf101d7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Student Conduct",
"objectStatus" : "ACTIVE"},
...
]
}
Get a Referral Source
GET /ssp/api/1/reference/referralSource/{id}
Security
SERVICE_REFERENCE_READ
Returns
ReferralSource
{"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"}
Create a Referral Source
POST /ssp/api/1/reference/referralSource
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"description" : "Campus Police",
"name" : "Campus Police"}
Returns
ReferralSource
{"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"}
Save a Referral Source
PUT /ssp/api/1/reference/referralSource/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"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"}
Returns
ReferralSource
{"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 a Referral Source
DELETE /ssp/api/1/reference/referralSource/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}