Versions Compared

Old Version 1

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Get My Caseload

Returns all students where I am the coachId. Defaults to only students with an active program status. Provides a view specific caseload record object as a container for simplicity and minimal data exchange.

GET /ssp/api/1/person/searchcaseload

Security

PERSON_CASELOAD_READ

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED
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)

Additional Search Criteria:
programStatus : <programStatusId>, default to ActiveoutsideCaseload : true/false
searchTerm : Can be firstName, lastName, studentId or firstName + ' ' + lastName

 

...

Returns 

Code Block
{"success":"true",
"message":"",
"results":12,
"rows":[
{"personId":"0a90940a-43e5-18fe-8143-e59ac7180002",
    "schoolId":"SSP1623",
    "firstName":"SSP",
    "middleName":"",
    "lastName":"1623",
    "birthDate":null,
    "studentTypeName":"Demo",
    "currentAppointmentStartTime":null,
    "studentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
    "id":"0a90940a-43e5-18fe-8143-e59ac7180002",
    "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
    "coachFirstName":"Amy",
    "coachLastName":"Administrator",
    "photoUrl"schoolId" : 3893748:"",
    "currentProgramStatusName":"Active"},
{"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "schoolId":"jason6",
    "firstName":"Jason",
    "middleName":"L",
 "Sally   "lastName":"Wood",
    "birthDate":"1983-08-20",
 "middleInitial" : null,
    "studentTypeName":"External",
    "currentAppointmentStartTime":null,
    "studentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
    "lastName" : "Student",
  "id":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
    "coachFirstName":"Amy",
    "coachLastName":"Administrator",
    "photoUrl" : null},
    "currentProgramStatusName":"Active"}
	...
  ]
}

 

Get a Specific Person's Caseload

Only users with appropriate permission to view another user's caseload will have access to this method.

GET /ssp/api/1/person/{1}/caseload

Security

PERSON_CASELOAD_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)

Additional Search Criteria:
programStatus : <programStatusId>, default to Active

Returns 

 

Code Block
{"id" : "63d62297-bf08-496f-acf3-0c129d437c2b"success":"true",
"message":"",
"results":12,
"rows":[
{"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "schoolId":"jason6",
 "schoolId" : 1038393,
    "firstName":"Jason",
    "middleName":"L",
    "lastName":"Wood",
    "birthDate":"1983-08-20",
    "studentTypeName":"firstNameExternal",
    "currentAppointmentStartTime":null,
    "BillstudentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
   "middleInitial" : null,
  "id":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
    "lastNamecoachFirstName" : "SmithAmy",
    "coachLastName":"Administrator",
    "photoUrl" : null},
      "currentProgramStatusName":"Active"}
	...
 
  ]
}