Versions Compared

Key

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

...

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 

List<CaseloadRecord>

CaseloadRecord
   - personId
   - schoolId
   - firstName
   - middleInitial
   - lastName
   - studentType
   - currentAppointmentStartTime
   - numberOfEarlyAlerts - Count of the EAs associated with the student where earlyAlert.closedDate is null.
   - 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" : "Early AlertDemo",
      "currentAppointmentStartTime":null,
:  1332216000000,  "studentIntakeComplete":false,
    "numberOfEarlyAlerts":0,
    "id": 2"0a90940a-43e5-18fe-8143-e59ac7180002",
    "coachId":"0a90940a-3efc-175f-813e-fc1ac581000b",
    "coachFirstName":"Amy",
 "studentIntakeComplete" : true}   "coachLastName":"Administrator",
    "photoUrl":"",
    "currentProgramStatusName":"Active"},
{"personId" : "63d622970a90940a-bf0841a4-496f10ca-acf38141-0c129d437c2ba4ac9a380004",
 
    "schoolId" : 3893748"jason6",
      "firstName" : "BillJason",

     "middleInitialmiddleName" : null"L",

     "lastName" : "SmithWood",
    "birthDate":"1983-08-20",
    "studentTypeName" : "TransferExternal",
      "currentAppointmentStartTime" : 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

...

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 

List<CaseloadRecord>

CaseloadRecord
   - personId
   - schoolId
   - firstName
   - middleInitial
   - lastName
   - studentType
   - currentAppointmentStartTime
   - 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",
 
    "currentAppointmentStartTimestudentTypeName" : 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",
      "currentAppointmentStartTimephotoUrl" : null,
      "numberOfEarlyAlertscurrentProgramStatusName" : 0,
      "studentIntakeComplete" : true},
     "Active"}
	...
 
  ]
}