GET profileList
Returns multiple record details for all profiles matching the specified criteria. Properties returned depend on the type of profile, whether values are available, and whether certain fields have been requested. Properties include information about the current user's access permissions to this profile.
This service returns a default maximum of 25 records per request. The items can be increased and additional paging requests can be made.
Records are only returned if the user has access to them.
URL
https://demo.onsocialcloud.com/api/profileList
Parameters
query | A text string to search for |
category | The name of one or more comma-separated categories to limit the results to |
subcategory | The name of a subcategory to limit the results to, a category must also be specified |
categoryId | The category id to limit the results to |
subcategoryId | The subcategory id to limit the results to, a categoryId must also be specified |
location | The name of a city, state, and or country to search near |
latitude | The latitude to search from, in decimal form |
longitude | The longitude to search from, in decimal form |
radius | The radius in miles to limit the results to |
fixed | Set to true to restrict the results to the specified radius, otherwise the radius increases until records are found |
view | The type of profile data to return (mine, checkins, hometown) |
filter | When viewing checkins, a filter to use (friends or users) |
permission | Return profiles based on a specific ConcourseConnect permission value |
sort | The sort order for the items returned (nearby, new, highest_rated, most_reviewed, most_popular, recent, alpha, desc, last_accessed) |
groupBy | Organize records by the specified grouping (category, location) |
parentUniqueId | Return children records of a parent profile |
profile | Combined with list, limit records to profiles contained in this profile uniqueId; if no list is specified then restricts the results to the specified uniqueId |
list | Combined with profile, limit records to profiles contained in this named list |
includeProfile | Combined with profile and list, set to true to include the specified profile in the results |
topLevelOnly | Set to true to return only the top-level records when there are children records in the results too |
items | The number of records to return |
page | The page number of records to return |
fields | A comma-separated list of fields to return |
Example Request
https://www.concursive.com/api/profileList?format=json&category=Groups&items=1
Example Result
[ { "status":{ "code":0, "name":"profileList", "count":1, "total":10 }, "objectList":[ { "recordNumber":1, "recordName":"profile", "id":"17178", "privacyType":"public", "canMessage":"true", "category":"Groups", "categoryLabel":"Community", "uniqueId":"community-contributions", "title":"Community Contributions", "distance":"-1.0", "distanceKm":"-1.0", "country":"UNITED STATES", "description":"Discussion and file sharing on community code and contributions.", "imageUrl":"http:\/\/www.concursive.com\/image\/2008090514-17178-9907-45x45-123456789-330878000-2\/programmer_monkey.jpg", "imageWidth":"45", "imageHeight":"45", "image100Url":"http:\/\/www.concursive.com\/image\/2008090514-17178-9907-100x100-123456789-330878000-2\/programmer_monkey.jpg", "image200Url":"http:\/\/www.concursive.com\/image\/2008090514-17178-9907-200x200-123456789-330878000-2\/programmer_monkey.jpg", "approved":"true", "closed":"false", "guests":"true", "participants":"true", "membership":"false", "readCount":"8058", "ratingCount":"0", "ratingValue":"0", "ratingAverage":"0", "teamMemberId":"20773", "isActiveMember":"true", "isPendingMember":"false", "canJoin":"false", "canRequestToJoin":"false", "canLeave":"false", "canPostActivity":"true", "canPostPhotos":"true", "canPostProfileImages":"true", "canDeleteProfileImages":"true", "canVote":"false", "canPostTopics":"false", "canInvite":"true", "canEditTeam":"true", "canEditInfo":"true", "canEditTaskFolders":"true", "canEditTasks":"true", "canPostEvents":"true", "canAddIssues":"true", "canShare":"true", "canAddProfiles":"true", "canCreateNotifications":"true", "canDeleteProfile":"true", "memberCount":"3", "hasFoursquareId":"false" } ] } ]
Sign in to add your comment.