Get All Categories
GET /ssp/api/1/reference/category
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
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"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" : "Athletics",
"description" : "Athletics description."},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"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" : "Displaced Workers",
"description" : "Displaced workers description."},
...
]
}
Get a Category
GET /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_READ
Returns
Category
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"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" : "Athletics",
"description" : "Athletics description."}
Create a Category
POST /ssp/api/1/reference/category
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"name" : "ARC.",
"description" : "Academic Resource Center"}
Returns
Category
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"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" : "ARC",
"description" : "Academic Resource Center."}
Save a Category
PUT /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"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" : "ARC",
"description" : "Academic Resource Center."}
Returns
Category
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"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" : "ARC",
"description" : "Academic Resource Center."}
Delete a Category
DELETE /ssp/api/1/reference/category/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"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
{"challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"}
Returns
{"success" : "true"}
or
{"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
{"challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"}
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}