Search Person
GET /ssp/api/1/person/search
Security
PERSON_SEARCH_READ, PERSON_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
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",
{"idstudentTypeName" : "63d62297-bf08-496f-acf3-0c129d437c2b"External",
"currentAppointmentStartTime":null,
"schoolIdstudentIntakeComplete":true,
: 1038393, "numberOfEarlyAlerts":7,
"firstNameid" : "Bill"77fdcb55-05e8-4508-9461-5004b811dbcd",
"middleInitial" : null,"coachId":"06f7b046-2239-4a4a-9ee0-030429081962",
"lastNamecoachFirstName" : "SmithRichard",
"photoUrlcoachLastName" : null},"Wilson",
"photoUrl":null,
... "currentProgramStatusName":"Active"}
]
} |