Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Search Person

GET /ssp/api/1/person/search

Security

PERSON_SEARCH_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
outsideCaseload : true/false
searchTerm : 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},
     {"id" : "63d62297-bf08-496f-acf3-0c129d437c2b",
      "schoolId" : 1038393,
      "firstName" : "Bill",
      "middleInitial" : null,
      "lastName" : "Smith",
      "photoUrl" : null},
      ...
    ]
}
  • No labels