Versions Compared

Old Version 1

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version 2

changes.mady.by.user Alexander Leader

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
[{"name" : "Child or Adult Care",
  "tasks" : 
    [{"id" : "23befc50-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" : 1332216000000,
      "completed" : false,
      "completedDate" : 1332216000000
      "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
      "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",
      "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" : 1332216000000
      "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
      "deletableByStudent" : true, 
      "closableByStudent" : true,
      "confidentialityLevel" : "DISABILITY",
      "type" : "SSP"},
     ...
    ]},
 {"name" : "Transportation",
  "tasks" : 
    [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : 1332216000000,
      "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "modifiedDate" : 1332216000000,
      "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "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" : 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,
      "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "modifiedDate" : 1332216000000,
      "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "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" : 1332216000000
      "challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975",
      "deletableByStudent" : true,
      "closableByStudent" : true,
      "confidentialityLevel" : "EVERYONE",
      "type" : "SSP"},
     ...
    ]},
   ...     
}]

 


Get

...

All Tasks

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

Returns

Goal

...

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",
  "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" : 1332216000000,
  "completed" : false,
  "completedDate" : 1332216000000
  "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
  "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",
  "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,
 "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" : 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,
 "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" : 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" : 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",
 "descriptioncreatedById" : "Naturalized Citizen.91f46e39-cea8-422b-b215-00f6bcf5d280",
 "idmodifiedDate" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"1332216000000,
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "modifiedDate"ACTIVE",
 "name" : "1332216000000Family Services",
 "description"  "objectStatus" : "ACTIVE",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" : "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"}

 

...

: "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" : 1332216000000,
 "completed" : false,
 "completedDate" : 1332216000000
 "challengeId" : "9D6E3B8F-AFB3-4D86-A527-9778035B94E1",
 "deletableByStudent" : true,
 "closableByStudent" : true,
 "confidentialityLevel" : "EVERYONE",
 "type" : "SSP"}

 

Delete a Task

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

Returns

Code Block
{"success" : "true"}

...