Search Person
GET /ssp/api/1/person/search
Security
PERSON_SEARCH_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 ActiverequireProgramStatusrequireProgramStatus : true/false, defaults to trueoutsideCaseload : true/falsesearchTerm : Can be firstName, lastName, studentId or firstName + ' ' + lastName
Returns
List<PersonSearchResultTO>
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"schoolId" : 3893748,
"firstName" : "Sally",
"middleInitial" : null,
"lastName" : "Student",
"photoUrl" : null,
"currentProgramStatusName" : "Active",
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"}},
{"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
"schoolId" : 1038393,
"firstName" : "Bill",
"middleInitial" : null,
"lastName" : "Smith",
"photoUrl" : null,
"currentProgramStatusName" : "Active"
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "Amy",
"lastName" : "Advisor",
"primaryEmailAddress" : "amy.advisor@university.edu",
"workPhone" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"}},
...
]
}