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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConnectionSuggestionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <Offset>0</Offset>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <ConnectionSuggestionsList>
    <Connection>
      <CanShow>
        <City>false</City>
        <Country>false</Country>
        <Email>false</Email>
        <EmployerName>false</EmployerName>
        <EmployerTitle>false</EmployerTitle>
        <Fax>false</Fax>
        <Location>false</Location>
        <Phone>false</Phone>
      </CanShow>
      <City>String</City>
      <ConnectionId>0</ConnectionId>
      <ConnectionName>String</ConnectionName>
      <ConnectionStatus>None</ConnectionStatus>
      <Country>String</Country>
      <Email>String</Email>
      <FaxAreaCode>String</FaxAreaCode>
      <FaxLabel>String</FaxLabel>
      <FaxNumber>String</FaxNumber>
      <FirstName>String</FirstName>
      <HeadShotImage>String</HeadShotImage>
      <IsAmbassador>false</IsAmbassador>
      <LastName>String</LastName>
      <Location>String</Location>
      <MemberType>String</MemberType>
      <Organization>String</Organization>
      <PhoneAreaCode>String</PhoneAreaCode>
      <PhoneLabel>String</PhoneLabel>
      <PhoneNumber>String</PhoneNumber>
      <Shared>false</Shared>
      <State>String</State>
      <WorkTitle>String</WorkTitle>
      <intCategoryID>0</intCategoryID>
    </Connection>
  </ConnectionSuggestionsList>
  <TotalResultsCount>0</TotalResultsCount>
</ConnectionSuggestionsResponse>