Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Get All Tasks

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

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<TaskGroup>

[{"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" : "",
      "reminderSentDate" : "",
      "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" : "",
      "reminderSentDate" : "",
      "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" : "",
      "reminderSentDate" : "",
      "completed" : false,
      "completedDate" : 1332216000000
      "challengeId" : "d40c7ca7-0da1-4a89-9322-5553153a2975",
      "deletableByStudent" : true,
      "closableByStudent" : true,
      "confidentialityLevel" : "EVERYONE",
      "type" : "SSP"},
     ...
    ]},
   ...     
}]

 

Get a Goal

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

Returns

Goal

{"createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "description" : "Naturalized Citizen.",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel" : "EVERYONE"}

 

Create a Goal

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

Sample Post

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

Returns

Goal

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

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

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

 

Delete a Goal

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

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels