Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

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 

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"personId" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "schoolId" : 3893748,
      "firstName" : "Sally",
      "middleInitial" : null,
      "lastName" : "Student",
      "studentTypeName" : "Early Alert",
      "nextAppointmentDate" : 1332216000000,
      "numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : true},
     {"personId" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "schoolId" : 3893748,
      "firstName" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "studentTypeName" : "Transfer",
      "nextAppointmentDate" : null,
      "numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : true},
     ...
    ]
}

 

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

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 

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"personId" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
      "schoolId" : 3893748,
      "firstName" : "Sally",
      "middleInitial" : null,
      "lastName" : "Student",
      "studentTypeName" : "Early Alert",
      "nextAppointmentDate" : 1332216000000,
      "numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : true},
     {"personId" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "schoolId" : 3893748,
      "firstName" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "studentTypeName" : "Transfer",
      "nextAppointmentDate" : null,
      "numberOfEarlyAlerts" : 2,
      "studentIntakeComplete" : true},
     ...
    ]
}
  • No labels