Versions Compared

Old Version 1

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"     "createdDate" : 1332216000000,
       "createdById"  : "91f46e39-cea8-422b-b215-00f6bcf5d280",
createdBy" : 
    "modifiedDate" : 1332216000000,       {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
       "objectStatus       "firstName" : "ACTIVEJohn",
              "namelastName" : "Family ServicesDoe"},
          "descriptionmodifiedDate" : "FAMILY SERVICES:1332216000000,
   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." "modifiedBy" : 
             {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "dueDatefirstName" : 1332216000000"John",
      "reminderSentDate" : 1332216000000,       "completedlastName" : false"Doe"},
      "completedDate" : 1332216000000       "challengeIdobjectStatus" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1ACTIVE",
      "deletableByStudent" : true,  "name" : "Family Services",
 "closableByStudent" : true,       "confidentialityLeveldescription" : "EVERYONE",FAMILY SERVICES:  Contact Pat Davis at "type"Family : "SSP"},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : 1332216000000,
      "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",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."
          "modifiedDatedueDate" : 1332216000000,
          "modifiedByIdreminderSentDate" : "91f46e39-cea8-422b-b215-00f6bcf5d280",1332216000000,
          "objectStatuscompleted" : "ACTIVE"false,
          "namecompletedDate" : "Montgomerynull
County Child Support Enforcement Agency",       "descriptionchallengeId" : "Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.",9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
          "deletableByStudent" : true,
          "dueDateclosableByStudent" : ""true,
       "reminderSentDate"  : "confidentialityLevel", :
     "completed" : false,       {"completedDateid" : 1332216000000
      "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1"c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "deletableByStudent" : true,        "closableByStudentname" : true"EVERYONE"}},
      "confidentialityLevel" : "DISABILITY",       "type" : "SSP"},
     ...
    ]},
 {"nameid" : "Transportation",
  "tasks" : 
    [{"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "createdDate" : 1332216000000,
        "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
createdBy" : 
    "modifiedDate" : 1332216000000,       {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "objectStatus" : "ACTIVE",       "namefirstName" : "$100 Pell Transfer to Tartan Card",John",
              "descriptionlastName" : "Doe"If},
you have Pell Grant visit the Bookstore within the first 2"modifiedDate" weeks: to1332216000000,
transfer up to $100 per quarter of your financial aid award"modifiedBy" to: your
tartan card to purchase bus pass(es) academic expenses and    daily expenses at Sinclair.{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "dueDate" : "",       "reminderSentDatefirstName" : "John",
      "completed" : false,      "lastName" : "completedDateDoe"},
  : 1332216000000       "challengeIdobjectStatus" : "d40c7ca7-0da1-4a89-9322-5553153a2975ACTIVE",
       "deletableByStudent   "name" : true,"Montgomery County Child Support Enforcement Agency",
 "closableByStudent" : true,       "confidentialityLeveldescription" : "EVERYONE",
      "type" : "SSP"},Contact Montgomery County Child Support Enforcement Agency for enforcement of child support orders 225-4600 www.mcsea.org.",
      {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",  "dueDate" : null,
          "createdDatereminderSentDate" : 1332216000000null,
          "createdByIdcompleted" : "91f46e39-cea8-422b-b215-00f6bcf5d280"false,
          "modifiedDatecompletedDate" : 1332216000000, null
          "modifiedByIdchallengeId" : "91f46e399D6E3B8F-cea8AFB3-422b4D86-b215A527-00f6bcf5d2809778035B94E1",
          "objectStatusdeletableByStudent" : "ACTIVE",true, 
          "nameclosableByStudent" : true,
"Student Card - Transportation",       "descriptionconfidentialityLevel" :
"Put money on Student Card to pay reduced fee of $1.00 for parking in garage daily.",{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
       "dueDate" : "",       "reminderSentDatename" : "EVERYONE"}},
          "completedtype" : false"SSP"},
      "completedDate"  : 1332216000000...
      "challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975" ]},
      {"deletableByStudentname" : true"Transportation",
      "closableByStudenttasks" : 
 true,       [{"confidentialityLevelid" : "EVERYONE23befc50-7f91-11e1-b0c4-0800200c9a66",
          "typecreatedDate" : "SSP"}1332216000000,
     ...     "createdBy" : 
   ]},    ...      }]

 

Get a Goal

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

Returns

Goal

Code Block
{"createdById" : "91f46e39-cea8-{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
              "createdDatefirstName" : "1332216000000John",
              "descriptionlastName" : "Naturalized Citizen.Doe"},
  "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",  "modifiedDate" : "1332216000000",
          "objectStatusmodifiedBy" : "ACTIVE", 
     "name" : "Earn a 2.0 Fall Term",  {"confidentialityLevelid" : "EVERYONE"}

 

Create a Goal

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

Sample Post

Code Block
{"confidentialityLevel" : "EVERYONE",
 "name" : "Earn a 2.0 Fall Term",
 "description" : "Earn a 2.0 Fall Term"}

Returns

Goal

Code Block
{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "Active",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" : "Everyone"}

 

Save a Goal

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

Sample Post

Code Block
{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "Active",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" : "Everyone"}

Returns

Goal

Code Block
{"id" : "5a8ecb01-e599-45a2-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "Active",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" : "Everyone"}

 

...

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

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

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

 

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)

Code Block
{"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

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

Only one of either recipientEmailAddresses or recipientIds is required. Both can be used.

Code Block
{"taskIds" : ["taskId1", "taskId2", "taskId3"], 
 "goalIds" : ["goalId1", "goalId2", "goalId3"],
 "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

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

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


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" : null
 "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" :
    {"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}/goaltask/{id}

Security

PERSON_TASK_DELETE

Returns

Code Block
{"success" : "true"}

...