...
GET /ssp/api/1/reference/challengeReferral
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)
Returns
List<ChallengeReferral>
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "fd01167f-f99c-456b-80ad-0fc44a99ac24",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Computer Access",
"description" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor.",
"publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."},
{"id" : "d1650a52-b6e0-415b-9781-38504be570ac",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Study Skills Website",
"description" : "Any student may access the study skills site designated for probation students at http://www.aims.edu/student/arc/index.php.",
"publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."},
...
]
} |
Get All Challenge Referrals for Challenge
GET /ssp/api/1/reference/challenge/{id}/challengeReferral
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE
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
| Code Block |
|---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "fd01167f-f99c-456b-80ad-0fc44a99ac24", "createdDate" : "2008-04-09T12:07:56", "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "2008-04-09T12:07:56", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "objectStatus" : "ACTIVE",, "name" : "Computer Access", "description" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor.", "publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."}, {"id" : "d1650a52-b6e0-415b-9781-38504be570ac", "createdDate" : "2008-04-09T12:07:56", "createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "2008-04-09T12:07:56", "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"},, "objectStatus" : "ACTIVE", "name" : "Study Skills Website", "description" : "Any student may access the study skills site designated for probation students at http://www.aims.edu/student/arc/index.php.", "publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."}, ... ] |
...
} |
Get One Challenge Referral
GET /ssp/api/1/reference/challengeReferral/{id}
Security
SERVICE_REFERENCE_READ
Returns
ChallengeReferral
| Code Block |
|---|
{"id" : "d1650a52-b6e0-415b-9781-38504be570ac",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Study Skills Website",
"description" : "Any student may access the study skills site designated for probation students at http://www.aims.edu/student/arc/index.php.",
"publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."} |
...
POST /ssp/api/1/reference/challengeReferral
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"name" : "Academic Petition",
"description" : "If poor grades are the result of emergency circumstances provide documentation to support an academic petition to Vice President for Instruction Office 7330. For more information please reference the Student Handbook at http://www.sinclair.edu/student/leader.",
"publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."} |
...
PUT /ssp/api/1/reference/challengeReferral/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "d1650a52-b6e0-415b-9781-38504be570ac",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "Active",
"name" : "Study Skills Website",
"description" : "Any student may access the study skills site designated for probation students at http://www.aims.edu/student/arc/index.php.",
"publicDescription" : "Free computer access may be found at the following locations: Local Community Libraries and Sinclair Community College Tartan Marketplace - lower level of building 7 Library Teleport - 13223 Walkway in building 14 second floor or Open Computer Lab Bldg. 14 first floor."} |
...
DELETE /ssp/api/1/reference/challengeReferral/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...