Get All Tasks By Group
GET /ssp/api/1/person/{id}/task/group
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)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"name" : "Child or Adult Care",
"tasks" :
[{"id" : "23befc50-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"},
{"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" : "Montgomery County Child Support Enforcement Agency",
"description" : "Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.",
"dueDate" : null,
"reminderSentDate" : null,
"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"},
...
]},
{"name" : "Transportation",
"tasks" :
[{"id" : "23befc50-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" : "$100 Pell Transfer to Tartan Card",
"description" : "If you have Pell Grant visit the Bookstore within the first 2 weeks to transfer up to $100 per quarter of your financial aid award to your tartan card to purchase bus pass(es) academic expenses and daily expenses at Sinclair.",
"dueDate" : null,
"reminderSentDate" : null,
"completed" : true,
"completedDate" : 1332216000000
"challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975",
"deletableByStudent" : true,
"closableByStudent" : true,
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}},
"type" : "SSP"},
{"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" : "Student Card - Transportation",
"description" : "Put money on Student Card to pay reduced fee of $1.00 for parking in garage daily.",
"dueDate" : null,
"reminderSentDate" : null,
"completed" : false,
"completedDate" : null
"challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975",
"deletableByStudent" : true,
"closableByStudent" : true,
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}},
"type" : "SSP"},
...
]},
...
}]
}
Get All Tasks
GET /ssp/api/1/person/{id}/task
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
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "23befc50-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" : true,
"completedDate" : 1332216000000
"challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
"deletableByStudent" : true,
"closableByStudent" : true,
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}},
"type" : "SSP"},
{"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" : "Montgomery County Child Support Enforcement Agency",
"description" : "Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.",
"dueDate" : "",
"reminderSentDate" : "",
"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"},
...
]
}
Get One Task
GET /ssp/api/1/person/{id}/task/{id}
Returns
Task
{"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"}
Print a Task List
If no tasks are selected, then just return the tasks for the person, (just for the session if it is the anon user).
POST /ssp/api/1/person/{id}/task/print
Parameters (as JSON)
{"taskIds" : ["taskId1", "taskId2", "taskId3"],
"goalIds" : ["goalId1", "goalId2", "goalId3"]}
Returns
PDF Report - To be completed by Unicon
Email a Task List
For each recipient send a unique email. Synchronous method that will return on success/failure. If no tasks are selected, then just return the tasks for the person, (just for the session if it is the anonymous user).
POST /ssp/api/1/person/{id}/task/email
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
Only one of either recipientEmailAddresses or recipientIds is required. Both can be used.
{"taskIds" : ["taskId1", "taskId2", "taskId3"],
"goalIds" : ["goalId1", "goalId2", "goalId3"],
"recipientIds" : ["recipientId1", "recipientId2"],
"recipientEmailAddresses" : ["test1@test.com", "test2@test.com", "test3@test.com"]}
Returns
ServiceResponse
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}
Create a Task
POST /ssp/api/1/person/{id}/task
Sample Post
{"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"}
Returns
Task
{"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"}
Save a Task
PUT /ssp/api/1/person/{id}/task/{id}
Sample Post
{"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"}
Returns
Task
{"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"}
completed and completedDate
A special note about these two properties in the Person Task Save API: The completed value is treated as the master property. Setting this value to anything it is not currently at will reset completedDate as appropriate. completedDate can be set to a date which will trigger completed to be true. However, after saving a Task, changing the completedDate to null will not reset completed to false. This only applies to changes to existing tasks. (See the discussion in SSP-127.)
Delete a Task
DELETE /ssp/api/1/person/{id}/task/{id}
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}