Loading ...

REST API: Get Connections | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Connections » REST API: Get Connections
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 29

REST API: Get Connections

0 
 /5
0 (0votes)

Get Connections

GET /api/users/{UserID}/friends

Get a list of connections of a particular user. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL as a path parameter ID of the user whose friends need to be returned.
Optional Parameters How to use Description
IsConfirmed &IsConfirmed=x - Used in the request URL as a query parameter Specifies whether to return only confirmed friends.
Page &Page=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/users/31/friends?IsConfirmed=true&Page=1&PageLength=10

Example Response

User JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":[
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10-b873e9f8-f062-413c-a386-cb680acdb4b5.png",
            "CreatedBy": 0,
            "Email": "bharper@communifire.com",
            "FirstName": "Bob",
            "Gender": 0,
            "IsActivated": false,
            "IsAnonymous": false,
            "IsAvatarApproved": false,
            "IsBanned": false,
            "IsConfirmed": true,
            "IsContactInfoVisible": true,
            "IsFeatured": false,
            "IsIsolated": false,
            "IsProfileCompleted": false,
            "IsOptInPromotionalEmails": false,
            "IsProfilePublic": true,
            "LastName": "Harper",
            "MediaServerRootURL": "https:/myintranet.communifire.com/Assets/Uploaded-Photos",
            "MembershipStatus": 0,
            "MembershipType": 0,
            "NumBlogPosts": 0,
            "NumPosts": 0,
            "PMNotification": false,
            "Points": 79,
            "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10-3aba367e-832a-4a44-8f19-d00c2471c45b.png",
            "ProfileURL": "https://myintranet.communifire.com/people/member1",
            "RankID": 1,
            "RankImage": "rank-lurker.gif",
            "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
            "RankName": "Lurky",
            "RequestMessage": "",
            "RoleID": 0,
            "ShowEmail": false,
            "SpaceID": 0,
            "UserID": 36,
            "UserInfoDisplayName": "Bob Harper",
            "UserName": "bharper",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "FriendID": 0,
            "TenantID": 0
        },
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10-b873e9f8-f062-413c-a386-cb680acdb4b5.png",
            "CreatedBy": 0,
            "Email": "ssmith@communifire.com",
            "FirstName": "Sandra",
            "Gender": 0,
            "IsActivated": false,
            "IsAnonymous": false,
            "IsAvatarApproved": false,
            "IsBanned": false,
            "IsConfirmed": true,
            "IsContactInfoVisible": true,
            "IsFeatured": false,
            "IsIsolated": false,
            "IsProfileCompleted": false,
            "IsOptInPromotionalEmails": false,
            "IsProfilePublic": true,
            "LastName": "Smith",
            "MediaServerRootURL": "https:/myintranet.communifire.com/Assets/Uploaded-Photos",
            "MembershipStatus": 0,
            "MembershipType": 0,
            "NumBlogPosts": 0,
            "NumPosts": 0,
            "PMNotification": false,
            "Points": 79,
            "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/10-3aba367e-832a-4a44-8f19-d00c2471c45b.png",
            "ProfileURL": "https://myintranet.communifire.com/people/member1",
            "RankID": 1,
            "RankImage": "rank-lurker.gif",
            "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
            "RankName": "Lurky",
            "RequestMessage": "",
            "RoleID": 0,
            "ShowEmail": false,
            "SpaceID": 0,
            "UserID": 84,
            "UserInfoDisplayName": "Sandra Smith",
            "UserName": "ssmith",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "FriendID": 0,
            "TenantID": 0
        }
    ]
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software