Find people associated with a school
Find people associated with a school.
If a method is not listed, it is not supported for this call
Parameters optional unless specified
|user_id||ID of user to query as.||Yes|
|SCHOOL_ID||ID of school to anchor on.||Yes|
|REL_TYPE||Optionally, return only those people associated by the specified relationship type. For valid values, see the entities attribute of the school object.|
If you want to search within results, type of search to execute. Valid values:
If you want to search within results, search query. Defaults to parsing natural language query. For more advanced queries, can include exact phrases surrounded by double-quotes ('"') and can precede required terms/phrases by a plus ('+') sign.
For expert level queries, can specify an exact query in Lucene query syntax and include the literal_context parameter.
|field_<name>||Filter the query for a specific value for a specific field. Fields are as specified for the fields parameter above.|
|literal_syntax||'true' to pass an exact Lucene-compatible query to be interpreted literally. (Note: for relevance queries with literal syntax, use text as the query attribute name)|
|union||If you want to find people connected to more than one school, you can pass a comma-separated list of additional school IDs in this parameter.|
|include_network_data||'true' to have the raw network data for the person's network identity(ies) included in the response|
|num||If querying list of users, can specify the number to return.|
|page||If querying list of users, specify the page to return (1-based).|
|detailed_results||'true' to return detailed person objects, rather than the default compact ones.|
|sort||Attribute to sort on (of person object)|
|sort_direction||desc or asc|
Search Results object.