...
status : ALL, ACTIVE, INACTIVE, DELETED
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)
...
Code Block |
---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "240e97c0-7fe5-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" : "Child Care", "description" : "Child care description text.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}}, {"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : "EVERYONE"}, ... {"id" ] }: "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}}, ... ] } |
Get All Challenges for Category
...
status : ALL, ACTIVE, INACTIVE, DELETED
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)
...
Code Block |
---|
{"success" : "true", "results" : "100", "rows" : [{"id" : "240e97c0-7fe5-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" : "Child Care", "description" : "Child care description text.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : "EVERYONE"}, {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}}, {"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : "EVERYONE"}, ... {"id" ] }: "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}}, ... ] } |
Get a Challenge
GET /ssp/api/1/reference/challenge/{id}
...
Code Block |
---|
{"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}} } |
Create a Challenge
POST /ssp/api/1/reference/challenge
...
Code Block |
---|
{"name" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}} |
Returns
Challenge
Code Block |
---|
{"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "selfHelpGuideDescription" : "", "defaultConfidentialityLevelname" : "EVERYONE"}} |
Save a Challenge
PUT /ssp/api/1/reference/challenge/{id}
...
Code Block |
---|
{"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "selfHelpGuideDescription" : "", "defaultConfidentialityLevelname" : "EVERYONE"}} |
Returns
Challenge
Code Block |
---|
{"id" : "3c952070-7fe5-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" : "Enhancing Academic Excellence", "description" : "Opportunities for students seeking to take their academics to the next level.", "tags" : "", "showInStudentIntake" : "true", "showInSelfHelpSearch" : "false", "selfHelpGuideQuestion" : "", "selfHelpGuideDescription" : "", "defaultConfidentialityLevel" : {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995", "name" : "EVERYONE"}} |
Delete a Challenge
DELETE /ssp/api/1/reference/challenge/{id}
...