Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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
outsideCaseload : true/false
searchTerm : Can be firstName, lastName, studentId or firstName + ' ' + lastName

 

Returns 
List<PersonSearchResultTO> 

Returns 

List<CaseloadRecord>

CaseloadRecord
   - personId
   - schoolId
   - firstName
   - middleInitial
   - lastName
   - studentType
   - nextAppointmentDate
   - numberOfEarlyAlerts
   - studentIntakeComplete 

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"idpersonId" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "schoolId" : 3893748,
      "firstName" : "Sally",
      "middleInitial" : null,
      "lastName" : "Student",
      "studentTypeName" : "",
      "nextAppointmentDate" : "",
      "photoUrl"numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : nulltrue},
     {"idpersonId" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "schoolId" : 10383933893748,
      "firstName" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "studentTypeName" : "",
      "nextAppointmentDate" : "",
      "photoUrl"numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : nulltrue},

     ...
    ]
}