Loading ...

REST API: Get Administrators | Communifire Documentation

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

REST API: Get Administrators

0 
 /5
0 (0votes)

Get Administrators

GET /api/users/administrators

Get a list of all users with the top level Site Administrator role or space Administrator role. 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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space from which the administrators are to be returned.

Example Request

GET https://myintranet.communifire.com/api/users/administrators?SpaceID=0

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":[
        {
            "AIM":null,
            "AvatarImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/",
            "AvatarPath":null,
            "Bio":null,
            "CreatedBy":0,
            "CreatedUser":null,
            "DOB":null,
            "DOBString":null,
            "DateBanned":null,
            "DateFormat":null,
            "DateJoined":"0001-01-01T00:00:00",
            "DateJoinedString":null,
            "DateLastVisited":null,
            "DateLastVisitedString":null,
            "DefaultCulture":null,
            "Description":null,
            "Email":"acme@acme.com",
            "EmailRecieve":1,
            "SpaceDigestOption":0,
            "FacebookURL":null,
            "FavoriteBooks":null,
            "FavoriteCuisines":null,
            "FavoriteMusic":null,
            "FavoriteTVShows":null,
            "FaxNumber":null,
            "FirstName":"Jon",
            "Gender":null,
            "GoogleIM":null,
            "HomePage":null,
            "ICQIM":null,
            "IP":null,
            "Image":null,
            "ImageString":null,
            "Interests":null,
            "InvitationID":0,
            "IsActivated":false,
            "IsAnonymous":false,
            "IsAvatarApproved":false,
            "IsBanned":false,
            "IsConfirmed":false,
            "IsContactInfoVisible":true,
            "IsFeatured":false,
            "IsIsolated":false,
            "IsProfileCompleted":false,
            "IsOptInPromotionalEmails":false,
            "IsPasswordEncrypted":false,
            "IsProfilePublic":false,
            "LastName":"Smith",
            "LinkedinURL":null,
            "Location":"",
            "MSN":null,
            "MembershipStatus":0,
            "MembershipType":0,
            "MetaDescription":null,
            "MetaKeywords":null,
            "MetaTitle":null,
            "MiddleName":null,
            "NumBlogPosts":0,
            "NumPosts":0,
            "Occupation":null,
            "Password":null,
            "PhoneNumber":null,
            "Points":0,
            "ProfileImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/10-e481a169-e506-4023-93c1-756621add3b2.png",
            "ProfilePhoto":null,
            "ProfileURL":\"http://myintranet.communifire.com/people/jon",
            "OnlineChatStatus":null,
            "RankID":0,
            "RankImage":null,
            "RankImageURL":null,
            "RankName":null,
            "RequestMessage":null,
            "Role":null,
            "RoleID":0,
            "Roles":null,
            "Salutation":null,
            "ShowEmail":false,
            "Signature":null,
            "SkypeIM":null,
            "SpaceID":0,
            "StatusNow":null,
            "TimeFormat":null,
            "TimeZoneID":"India Standard Time",
            "TwitterURL":null,
            "UserID":1,
            "UserInfoDisplayName":"Jon Smith",
            "UserName":"jon",
            "YIM":null,
            "CRMUserContactID":null,
            "HasJoinedViaThirdPartyLogin":false,
            "ChatStatusCssClass":null,
            "ChatStatusText":null,
            "UserAddress":null
        },
        {
            "AIM":null,
            "AvatarImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/",
            "AvatarPath":null,
            "Bio":null,
            "CreatedBy":0,
            "CreatedUser":null,
            "DOB":null,
            "DOBString":null,
            "DateBanned":null,
            "DateFormat":null,
            "DateJoined":"0001-01-01T00:00:00",
            "DateJoinedString":null,
            "DateLastVisited":null,
            "DateLastVisitedString":null,
            "DefaultCulture":null,
            "Description":null,
            "Email":"Ben@acme.com",
            "EmailRecieve":1,
            "SpaceDigestOption":0,
            "FacebookURL":null,
            "FavoriteBooks":null,
            "FavoriteCuisines":null,
            "FavoriteMusic":null,
            "FavoriteTVShows":null,
            "FaxNumber":null,
            "FirstName":"Ben",
            "Gender":null,
            "GoogleIM":null,
            "HomePage":null,
            "ICQIM":null,
            "IP":null,
            "Image":null,
            "ImageString":null,
            "Interests":null,
            "InvitationID":0,
            "IsActivated":false,
            "IsAnonymous":false,
            "IsAvatarApproved":false,
            "IsBanned":false,
            "IsConfirmed":false,
            "IsContactInfoVisible":true,
            "IsFeatured":false,
            "IsIsolated":false,
            "IsProfileCompleted":false,
            "IsOptInPromotionalEmails":false,
            "IsPasswordEncrypted":false,
            "IsProfilePublic":false,
            "LastName":"Lords",
            "LinkedinURL":null,
            "Location":"",
            "MSN":null,
            "MembershipStatus":0,
            "MembershipType":0,
            "MetaDescription":null,
            "MetaKeywords":null,
            "MetaTitle":null,
            "MiddleName":null,
            "NumBlogPosts":0,
            "NumPosts":0,
            "Occupation":null,
            "Password":null,
            "PhoneNumber":null,
            "Points":0,
            "ProfileImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/10-e481a169-e506-4023-93c1-756621add3b2.png",
            "ProfilePhoto":null,
            "ProfileURL":"http://myintranet.communifire.com/people/ben",
            "OnlineChatStatus":null,
            "RankID":0,
            "RankImage":null,
            "RankImageURL":null,
            "RankName":null,
            "RequestMessage":null,
            "Role":null,
            "RoleID":0,
            "Roles":null,
            "Salutation":null,
            "ShowEmail":false,
            "Signature":null,
            "SkypeIM":null,
            "SpaceID":0,
            "StatusNow":null,
            "TimeFormat":null,
            "TimeZoneID":"Central Standard Time",
            "TwitterURL":null,
            "UserID":3,
            "UserInfoDisplayName":"Ben Lords",
            "UserName":"ben",
            "YIM":null,
            "CRMUserContactID":null,
            "HasJoinedViaThirdPartyLogin":false,
            "ChatStatusCssClass":null,
            "ChatStatusText":null,
            "UserAddress":null,
        }
    ]
}


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

 

Wiki Index

Pages

Intranet Software