...
GET /ssp/api/1/person/caseload
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 Active
Returns
List<CaseloadRecord>
CaseloadRecord
- personId
- schoolId - firstName
- middleInitial
- lastName
- studentType
- nextAppointmentDate
- numberOfEarlyAlerts
- studentIntakeComplete
| Code Block |
|---|
{"success" : "true",
"resultsmessage" :"",
"100results":12,
"rows" :
[
[{"personId" : "58ba5ee30a90940a-734e43e5-4ae918fe-b9c58143-943774b4de41e59ac7180002",
"schoolId":"SSP1623",
"schoolIdfirstName":"SSP",
"middleName": 3893748"",
"lastName":"1623",
"birthDate":null,
"studentTypeName":"firstNameDemo",
"currentAppointmentStartTime":null,
"SallystudentIntakeComplete":false,
"numberOfEarlyAlerts":0,
"middleInitial" : null,
"id":"0a90940a-43e5-18fe-8143-e59ac7180002",
"coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
"coachFirstName":"Amy",
"coachLastName":"Administrator",
"photoUrl":"lastName",
"currentProgramStatusName":"Active"},
"Student{"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004",
"schoolId":"jason6",
"studentTypeNamefirstName" : "Jason",
"middleName":"L",
"nextAppointmentDatelastName" : "Wood",
"birthDate":"1983-08-20",
"numberOfEarlyAlertsstudentTypeName":"External",
: 2, "currentAppointmentStartTime":null,
"studentIntakeComplete":false,
"numberOfEarlyAlerts": true}0,
"id":"0a90940a-41a4-10ca-8141-a4ac9a380004",
{"personIdcoachId" : "63d622970a90940a-bf083efc-496f175f-acf3813e-0c129d437c2bfc1ac581000b",
"coachFirstName":"Amy",
"coachLastName"schoolId" : 3893748:"Administrator",
"photoUrl":null,
"currentProgramStatusName":"Active"}
...
]
"firstName" : "Bill",
} |
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 |
|---|
{"success":"true", "message":"", "results":12, "rows":[ {"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004", "schoolId":"middleInitialjason6", : null"firstName":"Jason", "middleName":"L", "lastName" : "SmithWood", "birthDate":"1983-08-20", "studentTypeName":"External", "currentAppointmentStartTime":null, "studentIntakeComplete":false, "numberOfEarlyAlerts":0, "nextAppointmentDateid" : ""0a90940a-41a4-10ca-8141-a4ac9a380004", "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b", "coachFirstName"numberOfEarlyAlerts:"Amy", : 2, "coachLastName":"Administrator", "studentIntakeCompletephotoUrl" : true}null, "currentProgramStatusName":"Active"} ... ] } |