Versions Compared

Old Version 4

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 All Task Groups with Tasks

...

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

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)

Returns

List<TaskGroup>

Code Block
Code Block
{"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" : 1332216000000null
          "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
 1332216000000         "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
          "deletableByStudent" : true, 
          "closableByStudent" : true,
          "confidentialityLevel" :
"DISABILITY",       "type" : "SSP"}     {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     ...       ]},  {"name" : "TransportationEVERYONE"}},
  "tasks"  :      [{"idtype" : "23befc50-7f91-11e1-b0c4-0800200c9a66"SSP"},
      "createdDate" : 1332216000000, ...
     "createdBy" :  ]},
        {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280Transportation",
  
       "firstNametasks" : "John",
          [{"lastNameid" : "Doe"},23befc50-7f91-11e1-b0c4-0800200c9a66",
          "modifiedDatecreatedDate" : 1332216000000,
          "modifiedBycreatedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},
          "objectStatusmodifiedDate" : "ACTIVE"1332216000000,
          "namemodifiedBy" : "$100
Pell Transfer   to Tartan Card",       {"descriptionid" : "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.",91f46e39-cea8-422b-b215-00f6bcf5d280",
              "firstName" : "John",
              "lastName" : "Doe"},
          "dueDateobjectStatus" : null"ACTIVE",
      "reminderSentDate" : null,       "completedname" : false,"$100 Pell Transfer to Tartan Card",
 "completedDate" : 1332216000000       "challengeIddescription" : "d40c7ca7-0da1-4a89-9322-5553153a2975",
      "deletableByStudent" : true,
      "closableByStudent" : true,
      "confidentialityLevel" : "EVERYONE",
      "type" : "SSP"},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",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.",
           "createdDatedueDate" : 1332216000000null,
      "createdBy" :    "reminderSentDate" : null,
          {"idcompleted" : "91f46e39-cea8-422b-b215-00f6bcf5d280"true,
          "firstNamecompletedDate" : "John",1332216000000
          "lastNamechallengeId" : "Doe"},d40c7ca7-0da1-4a89-9322-5553153a2975",
          "modifiedDatedeletableByStudent" : 1332216000000true,
          "modifiedByclosableByStudent" : true,
         { "idconfidentialityLevel" :
"91f46e39-cea8-422b-b215-00f6bcf5d280",             {"firstNameid" : "Johnc57f11e1-7ef2-4989-9ac2-7b0690563995",
              "lastNamename" : "DoeEVERYONE"}},
          "objectStatustype" : "ACTIVESSP"},
         {"nameid" : "Student Card - Transportation","7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "descriptioncreatedDate" : "Put1332216000000,
money on Student Card to pay reduced fee of $1.00 for parking in garage daily.", "createdBy" : 
             {"dueDateid" : null"91f46e39-cea8-422b-b215-00f6bcf5d280",
      "reminderSentDate" : null,       "completedfirstName" : false"John",
      "completedDate" : 1332216000000       "challengeIdlastName" : "d40c7ca7-0da1-4a89-9322-5553153a2975",Doe"},
          "deletableByStudentmodifiedDate" : true1332216000000,
          "closableByStudentmodifiedBy" : true,
       "confidentialityLevel      {"id" : "EVERYONE91f46e39-cea8-422b-b215-00f6bcf5d280",
      "type        "firstName" : "SSPJohn"},
           ...   "lastName" : ]"Doe"},
   ...       
}]

...

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
["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

Security

PERSON_TASK_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" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : 1332216000000,
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : 1332216000000,
      "modifiedBy" : 
         {"id" : "23befc5091f46e39-7f91cea8-11e1422b-b0c4-0800200c9a66",b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "objectStatus" : "ACTIVE",
      "createdDatename" : "Family 1332216000000Services",
      "createdBydescription" : "FAMILY SERVICES:  Contact Pat  {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",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."
      "lastNamedueDate" : "Doe"}1332216000000,
  "modifiedDate" : 1332216000000,   "modifiedByreminderSentDate" : 1332216000000,
      {"idcompleted" : "91f46e39-cea8-422b-b215-00f6bcf5d280"true,
      "firstNamecompletedDate" : "John",1332216000000
      "lastNamechallengeId" : "Doe"}9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
      "objectStatusdeletableByStudent" : "ACTIVE"true,
      "nameclosableByStudent" : true,
  "Family Services",   "descriptionconfidentialityLevel" :
"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{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
          "name" : "EVERYONE"}},
      "type" : "SSP"},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : 1332216000000,
      "completedcreatedBy" : 
false,    "completedDate" : 1332216000000   {"challengeIdid" : "9D6E3B8F91f46e39-AFB3cea8-4D86422b-A527b215-9778035B94E100f6bcf5d280",
  "deletableByStudent" : true,   "closableByStudent" : true,   "confidentialityLevelfirstName" : "EVERYONEJohn",
          "typelastName" : "SSPDoe"},
 {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",   "createdDatemodifiedDate" : 1332216000000,
      "createdBymodifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "lastNameobjectStatus" : "DoeACTIVE"},
      "modifiedDatename" : 1332216000000,
  "modifiedBy" :"Montgomery County Child Support Enforcement Agency",
      {"iddescription" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John"Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.",
      "lastNamedueDate" : "Doe"},
      "objectStatusreminderSentDate" : "ACTIVE",
      "namecompleted" : "Montgomeryfalse,
County Child Support Enforcement Agency",   "descriptioncompletedDate" : "Contactnull
Montgomery County Child Support Enforcement Agency for"challengeId" enforcement of child support orders 225-4600 www.mcsea.org.",
  "dueDate" : "",: "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
      "deletableByStudent" : true,
      "reminderSentDateclosableByStudent" : ""true,
      "completedconfidentialityLevel" :
 false,   "completedDate" : 1332216000000   {"challengeIdid" : "9D6E3B8Fc57f11e1-AFB37ef2-4D864989-A5279ac2-9778035B94E17b0690563995",
  "deletableByStudent" : true,   "closableByStudent" : true,   "confidentialityLevelname" : "DISABILITYEVERYONE"}},
      "type" : "SSP"},
     ...
    ]
}

 

Get One Task

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" : 1332216000000null
 "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

Security

PERSON_TASK_READ

Parameters (as JSON)

...

JSON)

Code Block
{"taskIds" : ["taskId1", "taskId2", "taskId3"],
 "goalIds" : ["goalId1", "id2goalId2", "id3goalId3"]}

Returns

PDF Report - To be completed by Unicon

 

Email a Task List

Foreach 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

Security

PERSON_TASK_READ

Parameters

taskIds : List<String> taskIds - Tasks to printinclude in the message
recipientIds : List<String> recipientIds - People to send email to by id- Send an e-mail copy the the e-mail address for these ids
recipientEmailAddresses : List<String> recipientEmailAddresses - Email addresses to send toSend 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.

Code Block
{"taskIds" : ["id1taskId1", "id2taskId2", "id3taskId3"], 
 "goalIds" : ["goalId1", "goalId2", "goalId3"],
 "recipientIds" : ["recipientId1", "recipientId2"], 
 "recipientEmailAddresses" : ["test1@test.com", "test2@test.com", "test3@test.com"]}

...

Code Block
{"success" : "false", 
 "message" : "Message when success is false."}

Create a Task

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" : 1332216000000null
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"id" : true"c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "closableByStudent" : true,  "confidentialityLevelname" : "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",
     "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" : 1332216000000true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"challengeIdid" : "9D6E3B8Fc57f11e1-AFB37ef2-4D864989-A5279ac2-9778035B94E17b0690563995",
 "deletableByStudent" : true,  "closableByStudentname" : true,
 "confidentialityLevel" : "EVERYONE"}},
 "type" : "SSP"}


Save a Task

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" : 1332216000000null
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "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",
     "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" : 1332216000000
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "challengeIdname" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1"EVERYONE"}},
 "deletableByStudenttype" : true,
 "closableByStudent" : true,
 "confidentialityLevel" : "EVERYONE",
 "type" : "SSP"}

 

"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}

Security

PERSON_TASK_DELETE

Returns

Code Block
{"success" : "true"}

...