Get All Challenges
GET /ssp/api/1/reference/challenge
Security
SERVICE_REFERENCE_READ
Parameters
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)
Returns
{"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" : "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"},
...
]
}
Get All Challenges for Category
GET /ssp/api/1/reference/category/{id}/challenge
Security
SERVICE_REFERENCE_READ
Parameters
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)
Returns
{"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" : "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"},
...
]
}
Get a Challenge
GET /ssp/api/1/reference/challenge/{id}
Security
SERVICE_REFERENCE_READ
Returns
Challenge
{"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"}
Create a Challenge
POST /ssp/api/1/reference/challenge
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"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"}
Returns
Challenge
{"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"}
Save a Challenge
PUT /ssp/api/1/reference/challenge/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"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"}
Returns
Challenge
{"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"}
Delete a Challenge
DELETE /ssp/api/1/reference/challenge/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}
Add a Referral to a Challenge
POST /ssp/api/1/reference/challenge/{id}/challengeReferral
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}
Remove a Referral from a Challenge
DELETE /ssp/api/1/reference/challenge/{id}/challengeReferral
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}