Versions Compared

Old Version 2

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Alexander Leader

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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)

Returns

List<Challenge>

Code Block
Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
      "createdDate" : "2008-04-09T12:07:56",
   "createdById   "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "2008-04-09T12:07:56",
      "modifiedById"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",
     "createdById "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "2008-04-09T12:07:56",
      "modifiedBy" : 
         {"modifiedByIdid" : "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 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" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" : 
    {"modifiedByIdid" : "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

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

Returns

Challenge

Code Block
{"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedBy" : 
    {"modifiedByIdid" : "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"}}

...

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" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedByIdmodifiedBy" : 
    {"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"}}
Returns
Challenge
 Code Block
{"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : "2008-04-09T12:07:56",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById"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"}
or
 Code Block
{"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
 Code Block
{"challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}
Returns
 Code Block
{"success" : "true"}
or
 Code Block
{"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
 Code Block
{"challengeReferralId" : "fd01167f-f99c-456b-80ad-0fc44a99ac24"}
Returns
 Code Block
{"success" : "true"}
...