...
GET /ssp/api/1/reference/campus
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>return
limit : Maximum number of results to return<br>return
sort : Property name<br>name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
ReturnsList<Campus>
| Code Block |
|---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b", "createdBy" : {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "modifiedById "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", "createdById "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "createdDate" : "1332216000000", "modifiedById "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}###
Security
SERVICE_REFERENCE_READ
Returns
| Code Block |
|---|
{"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
### Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"description" : "Main campus.", |
...
"name" : "Main Campus", "earlyAlertCoordinatorId" : "91f46e39-cea8-422b-b215-00f6bcf5d280"} |
### Returns
Campus
| Code Block |
|---|
{"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}
### Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"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
| Code Block |
|---|
{"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}
### Security
SERVICE_REFERENCE_WRITE
Returns{"ServiceResponse" :
| Code Block |
|---|
{"success" : "true" |
...
} |
or {"ServiceResponse" :
| Code Block |
|---|
{"success" : "false", |
...
"message" : "Message when success is false." |
...
} |