Get All Campuses
GET /ssp/api/1/reference/campus
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
{"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", "name" : "Main Campus", "description" : "Main campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}, {"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", "name" : "North Campus", "description" : "North campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}, ... ] }
Get a Campus
GET /ssp/api/1/reference/campus/{id}
Returns
{"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", "name" : "Main Campus", "description" : "Main campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Create a Campus
POST /ssp/api/1/reference/campus
Sample Post
{"description" : "Main campus.", "name" : "Main Campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Returns
Campus
{"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", "name" : "Main Campus", "description" : "Main campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Save a Campus
PUT /ssp/api/1/reference/campus/{id}
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", "objectStatus" : "ACTIVE", "name" : "Main Campus", "description" : "Main campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Returns
Campus
{"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", "name" : "Main Campus", "description" : "Main campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"}
Delete a Campus
DELETE /ssp/api/1/reference/campus/{id}
Returns
{"success" : "true"}
or
{"success" : "false", "message" : "Message when success is false."}