Versions Compared

Key

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

Get All Task Groups with Tasks

...

GET /ssp/api/1/person/{id}/task/group

Security

PERSON_TASK_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)

...

GET /ssp/api/1/person/{id}/task

Security

PERSON_TASK_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/person/{id}/task/{id}

Security

PERSON_TASK_READ

Returns

Task

Code Block
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "objectStatus" : "ACTIVE",
 "name" : "Family Services",
 "description" : "FAMILY SERVICES:  Contact Pat Davis at Family Services Association 222-9481 for parenting education program.  Parenting 101 Classes are offered throughout the year.  Sliding fee scale will establish the fee and scholarships may be available."
 "dueDate" : 1332216000000,
 "reminderSentDate" : 1332216000000,
 "completed" : false,
 "completedDate" : null
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}},
 "type" : "SSP"}

...

POST /ssp/api/1/person/{id}/task/print

Security

PERSON_TASK_READ

Parameters (as JSON)

Code Block
{"taskIds" : ["taskId1", "taskId2", "taskId3"],
 "goalIds" : ["goalId1", "goalId2", "goalId3"]}

...

POST /ssp/api/1/person/{id}/task/email

Security

PERSON_TASK_READ

Parameters

taskIds : List<String> taskIds - Tasks to include in the message
recipientIds : List<String> recipientIds - Send an e-mail copy the the e-mail address for these ids
recipientEmailAddresses : List<String> recipientEmailAddresses - Send an e-mail copy to these e-mail addresses, in addition to any recipientIds
goalIds : List<String> goalIds - Goals to include in the message

...

POST /ssp/api/1/person/{id}/task

Security

PERSON_TASK_WRITE

Sample Post

Code Block
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "objectStatus" : "ACTIVE",
 "name" : "Family Services",
 "description" : "FAMILY SERVICES:  Contact Pat Davis at Family Services Association 222-9481 for parenting education program.  Parenting 101 Classes are offered throughout the year.  Sliding fee scale will establish the fee and scholarships may be available."
 "dueDate" : 1332216000000,
 "reminderSentDate" : 1332216000000,
 "completed" : false,
 "completedDate" : null
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}},
 "type" : "SSP"}

...

PUT /ssp/api/1/person/{id}/task/{id}

Security

PERSON_TASK_WRITE

Sample Post

Code Block
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "objectStatus" : "ACTIVE",
 "name" : "Family Services",
 "description" : "FAMILY SERVICES:  Contact Pat Davis at Family Services Association 222-9481 for parenting education program.  Parenting 101 Classes are offered throughout the year.  Sliding fee scale will establish the fee and scholarships may be available."
 "dueDate" : 1332216000000,
 "reminderSentDate" : 1332216000000,
 "completed" : false,
 "completedDate" : null
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}},
 "type" : "SSP"}

...

DELETE /ssp/api/1/person/{id}/task/{id}

Security

PERSON_TASK_DELETE

Returns

Code Block
{"success" : "true"}

...