Search Person
GET /ssp/api/1/person/search
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>
{"success":"true",
"message":"",
"results":1,
"rows":[
{"personId":"77fdcb55-05e8-4508-9461-5004b811dbcd",
"schoolId":"jwilson219",
"firstName":"John",
"middleName":"Mumford",
"lastName":"Wilson",
"birthDate":"1983-08-20",
"studentTypeName":"External",
"currentAppointmentStartTime":null,
"studentIntakeComplete":true,
"numberOfEarlyAlerts":7,
"id":"77fdcb55-05e8-4508-9461-5004b811dbcd",
"coachId":"06f7b046-2239-4a4a-9ee0-030429081962",
"coachFirstName":"Richard",
"coachLastName":"Wilson",
"photoUrl":null,
"currentProgramStatusName":"Active"}
]
}