...
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)
...
| Code Block |
|---|
{"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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]},
{"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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]},
...
]
} |
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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]
} |
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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]
} |
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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]
} |
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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]
} |
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",
"earlyAlertRoutings" :
[{"id" : "aeb21037-512a-4c7e-a6fa-cd26ea533cc6",
"earlyAlertReasonId" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
"personId" : "10d6f4f2-cd80-4454-a475-4293dbaff436",
"groupName" : null,
"groupEmail" : null},
{"id" : "d5e4ecc4-9e48-46a1-a07b-763c18b2c813",
"earlyAlertReasonId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"personId" : null,
"groupName" : "Excessive Absences Email Group",
"groupEmail" : "excessive-absences@university.edu"},
...
]
} |
Delete a Campus
DELETE /ssp/api/1/reference/campus/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...