Loading ...

REST API: Get Users for Persona | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Personas » REST API: Get Users for Persona
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Users for Persona

0 
 /5
0 (0votes)

REST API: GET Users For Persona

GET api/personas/{personaID}/users

Used to get the users of persona by its Persona ID. Valid for Communifire version 8 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.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.
PersonaID Used in the request URL as a path parameter Unique identifier for a specific Persona.
Optional Parameters How to use Description
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page. (Default value is 20)

Example Request

GET https://myintranet.communifire.com/api/personas/1/users

Example Response

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": {
        "TotalUsersCount": 2,
        "Users": [
            {
                "Title": "Test Person 1",
                "Summary": "ASP Engineer - Executive",
                "IsIsolated": false,
                "WallPostToUserID": 0,
                "DateCreated": "0001-01-01T00:00:00",
                "DatePublished": "0001-01-01T00:00:00",
                "DateUpdated": "0001-01-01T00:00:00",
                "ShowDate": true,
                "ShowMetaData": true,
                "AuthorUserID": 0,
                "SpaceID": 0,
                "ContentStatusID": 0,
                "ContentCurrentWorkFlowStepID": 0,
                "EntityType": 0,
                "ContentID": 376,
                "ContentURL": "https://jd-demo.communifire.com/people/admin",
                "ContentImageURL": "https://jd-demo.communifire.com/Assets/Uploaded-Photos/376/94322d4f-354e-45b3-9f6b-bb3951513a35.jpeg",
                "ContentMediaServerID": 0,
                "WallID": 0,
                "GreatGrandParentContentID": 0,
                "IsPromoted": false,
                "ForumPostForumID": 0,
                "ForumPostTopicID": 0,
                "IsExternalContent": false,
                "ParentEntityType": 0,
                "ParentContentID": 0,
                "UserIsProfilePublic": false,
                "UserIsActivated": false,
                "CommentCount": 0,
                "LikeCount": 0,
                "PageViews": 0,
                "Rating": 0.0,
                "IsComment": false,
                "IsSpaceLevel": false,
                "IsFeatured": false,
                "IsLatest": false,
                "IsContentPubliclyAccessible": false,
                "IsAddedFromActivityStream": false,
                "ShowRating": false,
                "ShowViewCount": false,
                "ShowCommentCount": false,
                "EventStartDate": "0001-01-01T00:00:00",
                "IsRecurringTime": false,
                "EventEndDate": "0001-01-01T00:00:00",
                "EventScheduleStartDate": "0001-01-01T00:00:00",
                "EventScheduleEndDate": "0001-01-01T00:00:00",
                "EventCountryID": 0,
                "EventStateID": 0,
                "EventMetroID": 0,
                "EventIsAllDay": false,
                "EventIsPrivate": false,
                "EventTypeID": 0,
                "SpaceVisibility": 0,
                "TotalChildRecords": 0,
                "IsAwardPost": false,
                "AwardID": 0,
                "MembershipContentID": 0,
                "ConnectedToUser": false,
                "IssueCommentIsProjectActive": false,
                "IssueCommentIsInternal": false,
                "IssueCommentIssueID": 0,
                "ActivityActionEnum": 0,
                "ActivityLogBrowserType": 0,
                "ActivityLogOperatingSys": 0,
                "ActivityLogUserID": 0,
                "IndexedContentType": 0,
                "IsRequiredReading": false,
                "IsRequiredReadingConfirmed": false,
                "ContentVersionID": 0,
                "IsAnonymous": false
            },
            {
                "Title": "Test Man",
                "Summary": "Qa - Finance",
                "IsIsolated": false,
                "WallPostToUserID": 0,
                "DateCreated": "0001-01-01T00:00:00",
                "DatePublished": "0001-01-01T00:00:00",
                "DateUpdated": "0001-01-01T00:00:00",
                "ShowDate": true,
                "ShowMetaData": true,
                "AuthorUserID": 0,
                "SpaceID": 0,
                "ContentStatusID": 0,
                "ContentCurrentWorkFlowStepID": 0,
                "EntityType": 0,
                "ContentID": 630,
                "ContentURL": "https://jd-demo.communifire.com/people/tman1",
                "ContentImageURL": "https://jd-demo.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
                "ContentMediaServerID": 0,
                "WallID": 0,
                "GreatGrandParentContentID": 0,
                "IsPromoted": false,
                "ForumPostForumID": 0,
                "ForumPostTopicID": 0,
                "IsExternalContent": false,
                "ParentEntityType": 0,
                "ParentContentID": 0,
                "UserIsProfilePublic": false,
                "UserIsActivated": false,
                "CommentCount": 0,
                "LikeCount": 0,
                "PageViews": 0,
                "Rating": 0.0,
                "IsComment": false,
                "IsSpaceLevel": false,
                "IsFeatured": false,
                "IsLatest": false,
                "IsContentPubliclyAccessible": false,
                "IsAddedFromActivityStream": false,
                "ShowRating": false,
                "ShowViewCount": false,
                "ShowCommentCount": false,
                "EventStartDate": "0001-01-01T00:00:00",
                "IsRecurringTime": false,
                "EventEndDate": "0001-01-01T00:00:00",
                "EventScheduleStartDate": "0001-01-01T00:00:00",
                "EventScheduleEndDate": "0001-01-01T00:00:00",
                "EventCountryID": 0,
                "EventStateID": 0,
                "EventMetroID": 0,
                "EventIsAllDay": false,
                "EventIsPrivate": false,
                "EventTypeID": 0,
                "SpaceVisibility": 0,
                "TotalChildRecords": 0,
                "IsAwardPost": false,
                "AwardID": 0,
                "MembershipContentID": 0,
                "ConnectedToUser": false,
                "IssueCommentIsProjectActive": false,
                "IssueCommentIsInternal": false,
                "IssueCommentIssueID": 0,
                "ActivityActionEnum": 0,
                "ActivityLogBrowserType": 0,
                "ActivityLogOperatingSys": 0,
                "ActivityLogUserID": 0,
                "IndexedContentType": 0,
                "IsRequiredReading": false,
                "IsRequiredReadingConfirmed": false,
                "ContentVersionID": 0,
                "IsAnonymous": false
            }
        ],
        "TenantID": 0
    }
}

is returned as ResponseData.

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software