Find people associated with a person
https://api.knod.es/people/:PERSON_ID/people/:REL_TYPE
Find people associated with a person. At this time, relationship results (friend follower, etc) are only available if the person corresponds to the querying user
Requirements
Acting Customer | Yes |
---|---|
Acting User | Yes |
HTTP Methods
If a method is not listed, it is not supported for this call
GET | Execute query |
---|
Parameters
Parameters optional unless specified
Name | Description | Required? | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
user_id | ID of user to query as. | Yes | ||||||||||
PERSON_ID | ID of person to anchor on. You can use 'me' for the ID of the person associated with the querying user. | Yes | ||||||||||
REL_TYPE | Optionally, return only those people associated by the specified relationship type. For valid values, see the edges attribute of the person object. | |||||||||||
type |
If you want to search within results, type of search to execute. Valid values:
|
Yes | ||||||||||
q |
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. |
Yes | ||||||||||
fields |
Only for people
query type
|
|||||||||||
field_<name> | Filter the query for a specific value for a specific field. Fields are as specified for the fields parameter above. | |||||||||||
location | Limit results to those connected with a location that matches this query. (relevance search only) | |||||||||||
location_rel | Used with the location param, specifies a specific relationship with the location in question (if not specified will find people with any connection): lives-in, lived-in, from, been-to, checked-in, worked-in, went-to-school-in. Can pass multiple values separated by commas. | |||||||||||
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) | |||||||||||
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 |
Response
Search Results object.