Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Get All Challenges

GET /ssp/api/1/reference/challenge

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

List<Challenge>

[{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
  "createdDate" : "2008-04-09T12:07:56",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "2008-04-09T12:07:56",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "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",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "2008-04-09T12:07:56",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "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}

Returns

Challenge

{"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : "2008-04-09T12:07:56",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "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

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",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "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}

Sample Post

{"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : "2008-04-09T12:07:56",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "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",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "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}

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels