YM REST Services

<back to all web services

ConnectionSuggestions

Requires Authentication
Requires any of the roles:member, oauthmemberRequired permission:CanHaveBuddyList
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/ConnectionSuggestionsReturn a list of member suggested connections.
ConnectionSuggestions Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryint?No
PageNumberqueryint?No
Offsetqueryint?No
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ConnectionSuggestionsResponse Parameters:
NameParameterData TypeRequiredDescription
ConnectionSuggestionsListformList<Connection>No
TotalResultsCountformintNo
Connection Parameters:
NameParameterData TypeRequiredDescription
ConnectionStatusformConnectionStatus?No
ConnectionIdformintNo
FirstNameformstringNo
LastNameformstringNo
ConnectionNameformstringNo
OrganizationformstringNo
HeadShotImageformstringNo
WorkTitleformstringNo
MemberTypeformstringNo
CityformstringNo
StateformstringNo
LocationformstringNo
CountryformstringNo
SharedformboolNo
EmailformstringNo
PhoneLabelformstringNo
PhoneAreaCodeformstringNo
PhoneNumberformstringNo
FaxLabelformstringNo
FaxAreaCodeformstringNo
FaxNumberformstringNo
CanShowformShowPreferencesNo
intCategoryIDformintNo
IsAmbassadorformboolNo
ShowPreferences Parameters:
NameParameterData TypeRequiredDescription
CityformboolNo
LocationformboolNo
CountryformboolNo
PhoneformboolNo
FaxformboolNo
EmailformboolNo
EmployerNameformboolNo
EmployerTitleformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/Member/{MemberID}/ConnectionSuggestions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ConnectionSuggestionsList":[{"ConnectionStatus":"None","ConnectionId":0,"FirstName":"String","LastName":"String","ConnectionName":"String","Organization":"String","HeadShotImage":"String","WorkTitle":"String","MemberType":"String","City":"String","State":"String","Location":"String","Country":"String","Shared":false,"Email":"String","PhoneLabel":"String","PhoneAreaCode":"String","PhoneNumber":"String","FaxLabel":"String","FaxAreaCode":"String","FaxNumber":"String","CanShow":{"City":false,"Location":false,"Country":false,"Phone":false,"Fax":false,"Email":false,"EmployerName":false,"EmployerTitle":false},"intCategoryID":0,"IsAmbassador":false}],"TotalResultsCount":0,"PageSize":0,"PageNumber":0,"Offset":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T01:32:28.6806756-04:00","Device":"Desktop"}