Loading ...

REST API: Get Direct Reports | Communifire Documentation

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

REST API: Get Direct Reports

0 
 /5
0 (0votes)

Get Direct Reports

GET /api/users/{UserID}/directreports

Get a list of people who report to a particular user. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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 Unique ID of the user to get direct reports for.
Optional Parameters How to use Description
IncludeListHTML &IncludeListHTML=x - Used in the request URL as a query parameter Whether to include the HTML that displays in the user profile > Direct Reports. False by default.
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/376/directreports?PageLength=2

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": {
        "Records": [
            {
                "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/522/8ce74c9e-d46b-4d66-8b7e-b3e5d8d3f1f5.jpg",
                "AvatarPath": "8ce74c9e-d46b-4d66-8b7e-b3e5d8d3f1f5.jpg",
                "BlogID": 0,
                "DateFormat": "M/d/yyyy",
                "DateJoined": "2017-10-31T05:42:40.83",
                "DateJoinedString": "10/30/2017",
                "DateLastVisited": "2020-02-28T18:11:22.14",
                "DateLastVisitedString": "2/28/2020",
                "Email": "user1238@axerosolutions.com",
                "EmailRecieve": 3,
                "SpaceDigestOption": 1,
                "FirstName": "Raymond",
                "Gender": 0,
                "IP": "76.172.84.194",
                "InvitationID": 0,
                "IsActivated": true,
                "IsAnonymous": false,
                "IsUserLocked": false,
                "IsBanned": false,
                "IsConfirmed": false,
                "IsContactInfoVisible": true,
                "IsFeatured": false,
                "IsIsolated": false,
                "IsProfileCompleted": true,
                "IsOptInPromotionalEmails": false,
                "IsPasswordEncrypted": true,
                "IsProfilePublic": true,
                "LastName": "Flores",
                "MediaServerID": 58,
                "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
                "MembershipStatus": 0,
                "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
                "MetaKeywords": "user1238, ",
                "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
                "NumBlogPosts": 0,
                "NumPosts": 0,
                "Occupation": "VP Marketing",
                "PMNotification": false,
                "Password": "",
                "Points": 0,
                "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/522/e7f8e22d-ac52-4006-9743-0edd7b71d05d.jpg",
                "ProfilePhoto": "e7f8e22d-ac52-4006-9743-0edd7b71d05d.jpg",
                "ProfileURL": "https://myintranet.communifire.com/people/raymond",
                "OnlineChatStatus": 1,
                "RankID": 1,
                "RankImage": "rank-lurker.gif",
                "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
                "RankName": "Lurker",
                "Role": "Member",
                "RoleID": 0,
                "Roles": [
                    "Member"
                ],
                "ShowEmail": true,
                "TimeFormat": "h:mm tt",
                "TimeZoneID": "Pacific Standard Time",
                "UserID": 522,
                "UserInfoDisplayName": "Raymond Flores",
                "UserName": "raymond",
                "HasJoinedViaThirdPartyLogin": false,
                "IsWindowsADUser": false,
                "ChatStatusCssClass": "status-offline",
                "ChatStatusText": "Offline",
                "LastChatActivityDate": "2020-02-28T18:11:26.047",
                "UserPresenceStatus": 3,
                "SimpleFields": {
                    "9": {
                        "FieldUseID": 9,
                        "DataIDs": [
                        6045
                        ],
                        "RenderedValue": "<a href='mailto:user1238@axerosolutions.com' title='user1238@axerosolutions.com'>user1238@axerosolutions.com</a>",
                        "RenderedValues": [
                        "<a href='mailto:user1238@axerosolutions.com' title='user1238@axerosolutions.com'>user1238@axerosolutions.com</a>"
                        ],
                        "FieldUTCDates": [],
                        "LookupValues": [],
                        "FieldValues": [
                        "user1238@axerosolutions.com"
                        ],
                        "FieldValue2": "",
                        "FieldValues2": [],
                        "OptionResourceKeys": [],
                        "ChildFields": {},
                        "Indexed": false,
                        "IsPreference": false,
                        "SystemName": "SystemEmail",
                        "FieldType": 1,
                        "FieldSubType": 2,
                        "TenantID": 0
                    }
                },
                "IsPasswordHashed": true,
                "SupervisorID": 376,
                "DirectReportCount": 12,
                "InOrgChart": true,
                "UserListHTML": "<div class=\"p-photo\">\n    <a class=\"axero-user-card-link\" href=\"https://myintranet.communifire.com/people/raymond\" data-user=\"522\">\n        <img class=\"p-avatar\" src=\"https://myintranet.communifire.com/Assets/Uploaded-Photos/522/e7f8e22d-ac52-4006-9743-0edd7b71d05d.jpg\" alt=\"Raymond Flores\">\n    </a>\n    <i title=\"Offline\" class=\"icon-circle status-offline\"></i>\n</div>\n<div class=\"p-info\">\n    <div class=\"p-property p-name\"><a data-user=\"522\" class=\"axero-user-card-link\" href=\"https://myintranet.communifire.com/people/raymond\">Raymond Flores</a></div>\n    <div class=\"p-property p-department\">VP Marketing  - Marketing</div>\n    <div class=\"p-property p-location\">Albany, New York</div>\n</div>",
                "ConnectionStatus": 1,
                "CanChat": true,
                "SpaceIDs": [
                    252,
                    257,
                    262
                ],
                "RoleIDsTLC": [
                    3
                ],
                "ContentMemberships": [
                    1781,
                    7076
                ],
                "TenantID": 1
            },
            {
                "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/520/51b60dcf-7d78-4696-859b-4fb82dec2590.jpg",
                "AvatarPath": "51b60dcf-7d78-4696-859b-4fb82dec2590.jpg",
                "BlogID": 0,
                "DateFormat": "M/d/yyyy",
                "DateJoined": "2017-10-31T05:42:38.113",
                "DateJoinedString": "10/30/2017",
                "DateLastVisited": "2018-04-04T20:03:26.723",
                "DateLastVisitedString": "4/4/2018",
                "Email": "user1236@axerosolutions.com",
                "EmailRecieve": 3,
                "SpaceDigestOption": 1,
                "FirstName": "Kathy",
                "Gender": 0,
                "IP": "76.172.84.194",
                "InvitationID": 0,
                "IsActivated": true,
                "IsAnonymous": false,
                "IsUserLocked": false,
                "IsBanned": false,
                "IsConfirmed": false,
                "IsContactInfoVisible": true,
                "IsFeatured": false,
                "IsIsolated": false,
                "IsProfileCompleted": true,
                "IsOptInPromotionalEmails": false,
                "IsPasswordEncrypted": true,
                "IsProfilePublic": true,
                "LastName": "Harris",
                "MediaServerID": 58,
                "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
                "MembershipStatus": 1,
                "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
                "MetaKeywords": "user1236, ",
                "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
                "NumBlogPosts": 0,
                "NumPosts": 0,
                "Occupation": "VP IT",
                "PMNotification": false,
                "Password": "test",
                "Points": 0,
                "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/520/835a3ce4-6753-45ef-98d0-e20f9ecc51ae.jpg",
                "ProfilePhoto": "835a3ce4-6753-45ef-98d0-e20f9ecc51ae.jpg",
                "ProfileURL": "https://myintranet.communifire.com/people/kathy",
                "OnlineChatStatus": 1,
                "RankID": 1,
                "RankImage": "rank-lurker.gif",
                "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
                "RankName": "Lurker",
                "Role": "Member",
                "RoleID": 0,
                "Roles": [
                    "Member"
                ],
                "ShowEmail": true,
                "TimeFormat": "h:mm tt",
                "TimeZoneID": "Pacific Standard Time",
                "UserID": 520,
                "UserInfoDisplayName": "Kathy Harris",
                "UserName": "kathy",
                "HasJoinedViaThirdPartyLogin": false,
                "IsWindowsADUser": false,
                "ChatStatusCssClass": "status-offline",
                "ChatStatusText": "Offline",
                "LastChatActivityDate": "2018-04-04T20:03:34.363",
                "UserPresenceStatus": 3,
                "IsPasswordHashed": false,
                "SupervisorID": 376,
                "DirectReportCount": 2,
                "InOrgChart": true,
                "UserListHTML": "<div class=\"p-photo\">\n    <a class=\"axero-user-card-link\" href=\"https://myintranet.communifire.com/people/kathy\" data-user=\"520\">\n        <img class=\"p-avatar\" src=\"https://myintranet.communifire.com/Assets/Uploaded-Photos/520/835a3ce4-6753-45ef-98d0-e20f9ecc51ae.jpg\" alt=\"Kathy Harris\">\n    </a>\n    <i title=\"Offline\" class=\"icon-circle status-offline\"></i>\n</div>\n<div class=\"p-info\">\n    <div class=\"p-property p-name\"><a data-user=\"520\" class=\"axero-user-card-link\" href=\"https://myintranet.communifire.com/people/kathy\">Kathy Harris</a></div>\n    <div class=\"p-property p-department\">VP IT  - IT</div>\n    <div class=\"p-property p-location\">Valparaiso, Nebraska</div>\n</div>",
                "ConnectionStatus": 1,
                "CanChat": true,
                "SpaceIDs": [
                    252,
                    257,
                    262
                ],
                "RoleIDsTLC": [
                  3
                ],
                "ContentMemberships": [
                    1781,
                    7076
                ],
                "TenantID": 1
            }
        ],
        "TotalRecords": 5,
        "NoOfPages": 3,
        "IsCaptchaEnabledForPrivateMessage": false
    }
}

 

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

 

Wiki Index

Pages

Intranet Software