...
Security
PERSON_SEARCH_READ, PERSON_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
- requireProgramStatus: true/false, default to true, force to true is programStatusId is provided
- outsideCaseload : true/false
- searchTerm : Can be firstName, lastName, studentId or firstName + ' ' + lastName
Returns
List<PersonSearchResultTO>
| Code Block |
|---|
{"success" : "true",
"resultsmessage" :"",
"100results":1,
"rows" :
[
[{"idpersonId" : "58ba5ee377fdcb55-734e05e8-4ae94508-b9c59461-943774b4de415004b811dbcd",
"schoolId" : 3893748"jwilson219",
"firstName" : "SallyJohn",
"middleInitialmiddleName" : null"Mumford",
"lastName" : "StudentWilson",
"photoUrlbirthDate" : null:"1983-08-20",
"currentProgramStatusNamestudentTypeName" : "ActiveExternal",
"coachcurrentAppointmentStartTime" :
:null,
{"idstudentIntakeComplete" : "91f46e39-cea8-422b-b215-00f6bcf5d281",
:true,
"firstNamenumberOfEarlyAlerts" : "John",
7,
"lastNameid" : "Coach"}}"77fdcb55-05e8-4508-9461-5004b811dbcd",
{"idcoachId" : "63d6229706f7b046-bf082239-496f4a4a-acf39ee0-0c129d437c2b030429081962",
"schoolId" : 1038393,
"firstName" : "Bill"coachFirstName":"Richard",
"middleInitial" : null,
"lastName" : "Smith"coachLastName":"Wilson",
"photoUrl" : null,
"currentProgramStatusName" : "Active"
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d281",
"firstName" : "John",
"lastName" : "Coach"}},
...
]
} |