...
GET /ssp/api/1/reference/category
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<Category>
| Code Block |
|---|
| Code Block |
{"success" : "true", "results" : "100", "rows" : [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "createdDate" : "2008-04-09T12:07:56", "createdById"createdBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "2008-04-09T12:07:56", "modifiedById "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "objectStatus" : "ACTIVE", "name" : "Athletics", "description" : "Athletics description."}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : "2008-04-09T12:07:56", "createdBy" : {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : "2008-04-09T12:07:56", "modifiedById "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "objectStatus" : "ACTIVE", "name" : "Displaced Workers", "description" : "Displaced workers description."}, ... ] } |
Get a Category
GET /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_READ
Returns
Category
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "2008-04-09T12:07:56",
"createdByIdcreatedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "Athletics",
"description" : "Athletics description."} |
...
POST /ssp/api/1/reference/category
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"name" : "ARC.",
"description" : "Academic Resource Center"} |
...
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedById"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "ARC",
"description" : "Academic Resource Center."} |
...
PUT /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "ARC",
"description" : "Academic Resource Center."} |
...
| Code Block |
|---|
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"createdDate" : "2008-04-09T12:07:56",
"createdBy" :
{"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "2008-04-09T12:07:56",
"modifiedBy" :
{"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"objectStatus" : "ACTIVE",
"name" : "ARC",
"description" : "Academic Resource Center."} |
...
DELETE /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
or
| Code Block |
|---|
{"success" : "false",
"message" : "Message when success is false."} |
Add a Challenge to a Category
POST /ssp/api/1/reference/category/{id}/challenge
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"} |
Returns
| Code Block |
|---|
{"success" : "true"} |
or
| Code Block |
|---|
{"success" : "false",
"message" : "Message when success is false."} |
Remove a Challenge from a Category
DELETE /ssp/api/1/reference/category/{id}/challenge
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"} |
Returns
| Code Block |
|---|
{"success" : "true"} |
...