Versions Compared

Key

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

...

GET /ssp/api/1/reference/category

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)

...

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

Security

SERVICE_REFERENCE_READ

Returns

Category

Code Block
{"id" : "23befc50-7f91-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" : "Athletics",
 "description" : "Athletics description."}

...

POST /ssp/api/1/reference/category

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"name" : "ARC.",
 "description" : "Academic Resource Center"}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"id" : "23befc50-7f91-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" : "ARC",
 "description" : "Academic Resource Center."}

...

DELETE /ssp/api/1/reference/category/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"categoryId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"categoryId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "challengeId" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"}

...