Page Comparison

...

GET /ssp/api/1/reference/challenge

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)

ReturnsList<Challenge>

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" : "3c952070c57f11e1-7fe57ef2-11e14989-b0c49ac2-0800200c9a667b0690563995",
   "createdDate       "name" : "2008-04-09T12:"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"     "defaultConfidentialityLevel" : 
         {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
          "name" : "EVERYONE"}},
     ...
    ]
}

Get All Challenges for Category

GET /ssp/api/1/reference/category/{id}/challenge

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

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" : 
         {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
          "name" : "EVERYONE"}},
     ...
    ]

...

Get a Challenge

GET /ssp/api/1/reference/challenge/{id}

Security

SERVICE_REFERENCE_READ

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",
 "selfHelpGuideDescription" : "",  "defaultConfidentialityLevelname" : "EVERYONE"}}
}

Create a Challenge

POST /ssp/api/1/reference/challenge

Security

SERVICE_REFERENCE_WRITE

Sample Post

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",
 "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",
     "defaultConfidentialityLevelname" : "EVERYONE"}}

Save a Challenge

PUT /ssp/api/1/reference/challenge/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

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",
 "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}}

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...

POST /ssp/api/1/reference/challenge/{id}/challengeReferral

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"challengeId" : "3c952070-7fe5-11e1-b0c4-0800200c9a66", "challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}

...

DELETE /ssp/api/1/reference/challenge/{id}/challengeReferral

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"challengeId" : "3c952070-7fe5-11e1-b0c4-0800200c9a66", "challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}

...

Versions Compared

Old Version 4

New Version Current

Key

Get All Challenges for Category

Get a Challenge

Create a Challenge

Save a Challenge

Delete a Challenge