...
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
- currentAppointmentStartDate
- numberOfEarlyAlerts - count of the EA associated with the student - studentIntakeComplete -
| Code Block |
|---|
{"success" : "true",
"resultsmessage" :"",
"100results":12,
"rows" :[
[{"personId" : "58ba5ee30a90940a-734e43e5-4ae918fe-b9c58143-943774b4de41e59ac7180002",
"schoolId" : 1293898"SSP1623",
"firstName" : "SallySSP",
"middleInitialmiddleName" : null"",
"lastName" : "Student1623",
"birthDate":null,
"studentTypeName":"Demo",
"currentAppointmentStartTime":null,
"Early Alert" "studentIntakeComplete":false,
"numberOfEarlyAlerts":0,
"currentAppointmentStartDate" : 1332216000000,
id":"0a90940a-43e5-18fe-8143-e59ac7180002",
"coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
"numberOfEarlyAlertscoachFirstName":"Amy",
: 2, "coachLastName":"Administrator",
"studentIntakeCompletephotoUrl" : true}"",
"currentProgramStatusName":"Active"},
{"personId" : "63d622970a90940a-bf0841a4-496f10ca-acf38141-0c129d437c2ba4ac9a380004",
"schoolId" : 3893748,
"jason6",
"firstName" : "BillJason",
"middleInitialmiddleName" : null"L",
"lastName" : "SmithWood",
"birthDate":"1983-08-20",
"studentTypeName" : "TransferExternal",
"currentAppointmentStartDatecurrentAppointmentStartTime" : null,
"studentIntakeComplete":false,
"numberOfEarlyAlerts":0,
"id": 0"0a90940a-41a4-10ca-8141-a4ac9a380004",
"coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
"coachFirstName":"Amy",
"studentIntakeComplete" : true} "coachLastName":"Administrator",
"photoUrl":null,
"currentProgramStatusName":"Active"}
...
]
} |
Get a Specific Person's Caseload
...
GET /ssp/api/1/person/{1}/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
- currentAppointmentStartDate
- numberOfEarlyAlerts
- studentIntakeComplete
| Code Block |
|---|
{"success" : "true",
"resultsmessage" :"",
"100results":12,
"rows" :[
[{"personId" : "58ba5ee30a90940a-734e41a4-4ae910ca-b9c58141-943774b4de41a4ac9a380004",
"schoolId" : 1293898"jason6",
"firstName" : "SallyJason",
"middleInitialmiddleName" : null"L",
"lastName" : "StudentWood",
"studentTypeNamebirthDate" : "Early Alert"1983-08-20",
"currentAppointmentStartDatestudentTypeName" : 1332216000000,
"numberOfEarlyAlerts" : 2"External",
"studentIntakeCompletecurrentAppointmentStartTime" : true}null,
{"personIdstudentIntakeComplete" : "63d62297-bf08-496f-acf3-0c129d437c2b":false,
"schoolIdnumberOfEarlyAlerts" : 38937480,
"firstNameid" : "Bill"0a90940a-41a4-10ca-8141-a4ac9a380004",
"middleInitialcoachId" : null:"0a90940a-3efc-175f-813e-fc1ac581000b",
"lastNamecoachFirstName" : "SmithAmy",
"studentTypeNamecoachLastName" : "TransferAdministrator",
"currentAppointmentStartDatephotoUrl" : null,
"numberOfEarlyAlertscurrentProgramStatusName" : 0,
"studentIntakeComplete" : true},
"Active"}
...
]
} |