...
Code Block |
---|
[{"name" : "Child or Adult Care", "tasks" : [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdByIdcreatedBy" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : 1332216000000, "modifiedById {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "objectStatusfirstName" : "ACTIVEJohn", "namelastName" : "Family ServicesDoe"}, "descriptionmodifiedDate" : 1332216000000, "FAMILY SERVICES "modifiedBy" : 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{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "reminderSentDateobjectStatus" : 1332216000000"ACTIVE", "completedname" : "Family falseServices", "completedDatedescription" : 1332216000000"FAMILY SERVICES: Contact Pat Davis at Family "challengeId"Services :Association "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true,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." "confidentialityLeveldueDate" : "EVERYONE"1332216000000, "typereminderSentDate" : "SSP"}1332216000000, {"idcompleted" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"false, "createdDatecompletedDate" : 1332216000000, "createdByIdchallengeId" : "91f46e399D6E3B8F-cea8AFB3-422b4D86-b215A527-00f6bcf5d2809778035B94E1", "modifiedDatedeletableByStudent" : 1332216000000true, "modifiedByIdclosableByStudent" : "91f46e39-cea8-422b-b215-00f6bcf5d280"true, "objectStatusconfidentialityLevel" : "ACTIVEEVERYONE", "nametype" : "Montgomery County Child Support Enforcement AgencySSP"}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "descriptioncreatedDate" : "Contact1332216000000, Montgomery County Child Support Enforcement Agency for"createdBy" enforcement: of child support orders 225-4600 www.mcsea.org.", {"id" : "dueDate" : null,91f46e39-cea8-422b-b215-00f6bcf5d280", "reminderSentDatefirstName" : null"John", "completedlastName" : false"Doe"}, "completedDatemodifiedDate" : 1332216000000, "challengeIdmodifiedBy" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "closableByStudent" : true, "confidentialityLevelfirstName" : "DISABILITYJohn", "typelastName" : "SSPDoe"}, ... ]}, {"name"objectStatus" : "TransportationACTIVE", "tasks" : [{"idname" : "23befc50-7f91-11e1-b0c4-0800200c9a66Montgomery County Child Support Enforcement Agency", "createdDatedescription" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.", "modifiedDatedueDate" : 1332216000000null, "modifiedByIdreminderSentDate" : "91f46e39-cea8-422b-b215-00f6bcf5d280"null, "objectStatuscompleted" : "ACTIVE"false, "namecompletedDate" : "$100 Pell Transfer to Tartan Card1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "descriptiondeletableByStudent" : "Iftrue, you have Pell Grant visit the Bookstore"closableByStudent" within: thetrue, first 2 weeks to transfer up to"confidentialityLevel" $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,: "DISABILITY", "type" : "SSP"}, ... ]}, {"name" : "Transportation", "tasks" : [{"reminderSentDateid" : null"23befc50-7f91-11e1-b0c4-0800200c9a66", "completedcreatedDate" : false1332216000000, "completedDatecreatedBy" : 1332216000000 {"challengeIdid" : "d40c7ca791f46e39-0da1cea8-4a89422b-9322b215-5553153a297500f6bcf5d280", "deletableByStudentfirstName" : true"John", "closableByStudentlastName" : true"Doe"}, "confidentialityLevelmodifiedDate" : "EVERYONE"1332216000000, "typemodifiedBy" : "SSP"}, {"id" : "7ed6d72091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280", "createdDate" : 1332216000000, "createdByIdfirstName" : "91f46e39-cea8-422b-b215-00f6bcf5d280John", "modifiedDate" : 1332216000000, "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Doe"}, "objectStatus" : "ACTIVE", "name" : "Student$100 CardPell - TransportationTransfer to Tartan Card", "description" : "PutIf moneyyou onhave StudentPell CardGrant tovisit paythe reducedBookstore feewithin ofthe $1.00first for2 parkingweeks into garage daily.", "dueDate" : null, "reminderSentDate" :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" : false, "completedDate" : 1332216000000 "challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"}, ... {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", ]}, ..."createdDate" : 1332216000000, "createdBy" : }] |
...
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
List<Task>
Code Block |
---|
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "firstName" : "John", "lastName" : "Doe"}, "modifiedDate" : 1332216000000, "modifiedById "modifiedBy" : {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "objectStatus "firstName" : "ACTIVEJohn", "name "lastName" : "Family ServicesDoe"}, "descriptionobjectStatus" : "FAMILY SERVICES:ACTIVE", Contact Pat Davis at"name" Family: Services"Student AssociationCard 222-9481 forTransportation", parenting education program. Parenting 101 Classes"description" are: offered"Put throughoutmoney theon year.Student Card Slidingto pay reduced fee of scale$1.00 willfor establishparking thein fee and scholarships may be available."garage daily.", "dueDate" : 1332216000000null, "reminderSentDate" : 1332216000000null, "completed" : false, "completedDate" : 1332216000000 "challengeId" : "9D6E3B8Fd40c7ca7-AFB30da1-4D864a89-A5279322-9778035B94E15553153a2975", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", ... "createdDate" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280" ]}, "modifiedDate" : 1332216000000, ... "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "objectStatus" : "ACTIVE", "name" : "Montgomery County Child Support Enforcement Agency }] |
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
List<Task>
Code Block |
---|
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "descriptioncreatedDate" : "Contact1332216000000, Montgomery County Child"createdBy" Support: Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "dueDatefirstName" : "John", "reminderSentDatelastName" : "Doe"}, "completedmodifiedDate" : false1332216000000, "completedDatemodifiedBy" : 1332216000000 {"challengeIdid" : "9D6E3B8F91f46e39-AFB3cea8-4D86422b-A527b215-9778035B94E100f6bcf5d280", "deletableByStudentfirstName" : true"John", "closableByStudentlastName" : true"Doe"}, "confidentialityLevelobjectStatus" : "DISABILITYACTIVE", "typename" : "SSPFamily Services"}, "description" ... ] |
Get One Task
GET /ssp/api/1/person/{id}/task/{id}
Returns
Task
Code Block |
---|
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate: "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, "modifiedByIdreminderSentDate" : "91f46e39-cea8-422b-b215-00f6bcf5d280"1332216000000, "objectStatuscompleted" : "ACTIVE"false, "namecompletedDate" : "Family1332216000000 Services", "descriptionchallengeId" : "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, "reminderSentDate9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"}, {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "completedcreatedBy" : false, "completedDate" : 1332216000000 {"challengeIdid" : "9D6E3B8F91f46e39-AFB3cea8-4D86422b-A527b215-9778035B94E100f6bcf5d280", "deletableByStudentfirstName" : true"John", "closableByStudentlastName" : true"Doe"}, "confidentialityLevelmodifiedDate" : 1332216000000, "EVERYONE",modifiedBy" : {"typeid" : "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)
Code Block |
---|
["id1", "id2", "id3"] |
Returns
PDF Report - To be completed by Unicon
Email a Task List
Foreach 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 print
recipientIds : List<String> recipientIds - People to send email to by id
recipientEmailAddresses : List<String> recipientEmailAddresses - Email addresses to send to
Only one of either recipientEmailAddresses or recipientIds is required. Both can be used.
Code Block |
---|
{"taskIds" : ["id1", "id2", "id3"],
"recipientIds" : ["recipientId1", "recipientId2"],
"recipientEmailAddresses" : ["test1@test.com", "test2@test.com", "test3@test.com"]} |
Returns
ServiceResponse
Code Block |
---|
{"success" : "true"} |
or
Code Block |
---|
{"success" : "false",
"message" : "Message when success is false."} |
Create a Task
POST /ssp/api/1/person/{id}/task
Sample Post
Code Block |
---|
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdById91f46e39-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" : 1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "DISABILITY", "type" : "SSP"}, ... ] |
Get One Task
GET /ssp/api/1/person/{id}/task/{id}
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" : 1332216000000
"challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
"deletableByStudent" : true,
"closableByStudent" : true,
"confidentialityLevel" : "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)
Code Block |
---|
["id1", "id2", "id3"] |
Returns
PDF Report - To be completed by Unicon
Email a Task List
Foreach 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 print
recipientIds : List<String> recipientIds - People to send email to by id
recipientEmailAddresses : List<String> recipientEmailAddresses - Email addresses to send to
Only one of either recipientEmailAddresses or recipientIds is required. Both can be used.
Code Block |
---|
{"taskIds" : ["id1", "id2", "id3"],
"recipientIds" : ["recipientId1", "recipientId2"],
"recipientEmailAddresses" : ["test1@test.com", "test2@test.com", "test3@test.com"]} |
Returns
ServiceResponse
Code Block |
---|
{"success" : "true"} |
or
Code Block |
---|
{"success" : "false",
"message" : "Message when success is false."} |
Create a Task
POST /ssp/api/1/person/{id}/task
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" : 1332216000000
"challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
"deletableByStudent" : true,
"closableByStudent" : true,
"confidentialityLevel" : "EVERYONE",
"type" : "SSP"} |
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", "modifiedDatefirstName" : 1332216000000, "John", "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"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" : 1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"} |
Returns
Task
Code Block |
---|
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : 1332216000000, "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "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. 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" : 1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"} |
Save a Task
PUT /ssp/api/1/person/{id}/task/{id}
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, "completedmodifiedBy" : false, {"completedDateid" : 1332216000000 "91f46e39-cea8-422b-b215-00f6bcf5d280", "challengeIdfirstName" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1John", "deletableByStudentlastName" : true"Doe"}, "closableByStudentobjectStatus" : true : "ACTIVE", "confidentialityLevelname" : "EVERYONEFamily Services", "typedescription" : "SSP"} |
...
PUT /ssp/api/1/person/{id}/task/{id}
Sample Post
Code Block |
---|
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDate" : 1332216000000, "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "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, "reminderSentDateFAMILY 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" : 1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"} |
Returns
Task
Code Block |
---|
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "createdDate" : 1332216000000, "completedcreatedBy" : false, "completedDate" : 1332216000000 {"challengeIdid" : "9D6E3B8F91f46e39-AFB3cea8-4D86422b-A527b215-9778035B94E100f6bcf5d280", "deletableByStudent" : true, "closableByStudentfirstName" : true, "confidentialityLevel" : "EVERYONE"John", "typelastName" : "SSPDoe"} |
Returns
Task
Code Block |
---|
{"id, "modifiedDate" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"1332216000000, "createdDatemodifiedBy" : 1332216000000, {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280", "modifiedDatefirstName" : 1332216000000"John", "modifiedByIdlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"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" : 1332216000000 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1", "deletableByStudent" : true, "closableByStudent" : true, "confidentialityLevel" : "EVERYONE", "type" : "SSP"} |
...