Caseload API

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

{"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":"",
    "currentProgramStatusName":"Active"},
{"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "schoolId":"jason6",
    "firstName":"Jason",
    "middleName":"L",
    "lastName":"Wood",
    "birthDate":"1983-08-20",
    "studentTypeName":"External",
    "currentAppointmentStartTime":null,
    "studentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
    "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

{"success":"true",
"message":"",
"results":12,
"rows":[
{"personId":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "schoolId":"jason6",
    "firstName":"Jason",
    "middleName":"L",
    "lastName":"Wood",
    "birthDate":"1983-08-20",
    "studentTypeName":"External",
    "currentAppointmentStartTime":null,
    "studentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
    "id":"0a90940a-41a4-10ca-8141-a4ac9a380004",
    "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
    "coachFirstName":"Amy",
    "coachLastName":"Administrator",
    "photoUrl":null,
    "currentProgramStatusName":"Active"}
	...
  ]
}