...
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",
"middleInitial" : null,
"lastName" : "Student",
"middleName":"Mumford",
"photoUrllastName" : null,
"currentProgramStatusName" : "Active",
"Wilson",
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280birthDate":"1983-08-20",
"firstName" : "Amy",
"studentTypeName":"External",
"lastNamecurrentAppointmentStartTime" : "Advisor",
null,
"primaryEmailAddressstudentIntakeComplete" : "amy.advisor@university.edu",
:true,
"workPhonenumberOfEarlyAlerts" : "(123) 456-7890",
:7,
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"}},
{"id" : "63d6229777fdcb55-bf0805e8-496f4508-acf39461-0c129d437c2b5004b811dbcd",
"schoolId" : 1038393,
"firstName" : "Bill",
"middleInitial" : null,
"lastName" : "Smith",
"photoUrl" : null,
"currentProgramStatusName" : "Active"
"coach" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"coachId":"06f7b046-2239-4a4a-9ee0-030429081962",
"firstNamecoachFirstName" : "AmyRichard",
"lastNamecoachLastName" : "AdvisorWilson",
"primaryEmailAddressphotoUrl" : "amy.advisor@university.edu",
:null,
"workPhonecurrentProgramStatusName" : "(123) 456-7890",
"officeLocation" : "123 Benton Hall Room A",
"departmentName" : "Engineering & Applied Science"}},
...
"Active"}
]
} |