Loading ...

REST API: Get Space | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Get Space
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 13

REST API: Get Space

0 
 /5
0 (0votes)

Get space

GET /api/spaces/{spaceid}

Get a space from database. 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 Used in the request URL (see below) Unique identifier for a particular space.
ShowBasicInfoIfNoPermission Used in the request URL (see below)

Set it to true if you want to fetch basic information of a space, when user does not have permission to view that space.

To enable this feature, a system property named "ShowPrivateSpaceJoinPage" has to be true.

Example URL to GET: http://your-community.com/api/spaces/187

Response JSON sample where space JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call. Note that some properties are removed from this sample to make it shorter.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
                        {
                            "SpaceID":186,
                            "ParentSpaceID":0,
                            "IsFeatured":false,
                            "Stub":"support",
                            "LandingPage":null,
                            "TotalMembers":1,
                            "CreatedBy":1,
                            "UserID":1,
                            "EntityID":0,
                            "EntityType":0,
                            "SpaceName":"Support",
                            "Author":null,
                            "Description":In a support group, members provide each other with various types of help. Members with the same issues can come together for sharing coping strategies, to feel more empowered and for a sense of community.",
                            "UserName":"john",
                            "UserFirstName":"John",
                            "UserLastName":"Smith",
                            "UserEmail":"acme@acme.com",
                            "StatusID":1,
                            "MembershipType":0,
                            "SpaceVisibility":1,
                            "DateCreated":"2016-02-01T07:56:30.86",
                            "WorkFlowID":0,
                            "CurrentWorkFlowStepID":0,
                            "IsArticleWorkflowActive":false,
                            "IsBlogWorkflowActive":false,
                            "IsEventWorkflowActive":false,
                            "IsForumWorkflowActive":false,
                            "IsWikiWorkflowActive":false,
                            "IsFileWorkflowActive":false,
                            "IsPhotoWorkFlowActive":false,
                            "IsVideoWorkFlowActive":false,
                            "EnableForums":false,
                            "EnableSurveys":false,
                            "EnablePhotos":false,
                            "EnableTaskManager":false,
                            "EnableFiles":false,
                            "EnableWiki":false,
                            "EnableEvents":false,
                            "EnableArticles":false,
                            "EnableBlogs":false,
                            "EnableVideos":false,
                            "EnableIssueTracker":false,
                            "EnableFileControl":false,
                            "GroupPictureFileName":"",
                            "SpaceIconFileName":"",
                            "SpaceIconURL":"/Themes/default/images/space-default.png",
                            "MediaServerID":3,
                            "SpaceMediaServerRootURL":"http://your-community.com/Assets/Uploaded-CMS-Files",
                            "UserMediaServerRootURL":"http://your-community.com/Assets/Uploaded-Photos",
                            "SpaceURL":"/spaces/186/support",
                            "UpdatedByUserID":0,
                            "InvitationExpiryInDays":0,
                            "DisableWallEmailNotifications":false,
                            "AutoSubscribeEmail":true,
                            "Image":null,
                            "SpaceImageURL":"/Themes/default/images/space-default.png",
                            "IsArticleCommentWorkflowActive":false,
                            "IsBlogEntryCommentWorkflowActive":false,
                            "IsEventCommentWorkflowActive":false,
                            "IsForumPostWorkflowActive":false,
                            "IsPhotoCommentWorkflowActive":false,
                            "IsVideoCommentWorkflowActive":false,
                            "IsWikiCommentWorkflowActive":false,
                            "IsFileCommentWorkflowActive":false,
                            "IsIdeaCommentWorkflowActive":false,
                            "SpaceHeaderImageFileName":null,
                            "EnableUpcomingBirthdaysControl":false,
                            "EnableContentReadConfirmation":false
                        }
}

 

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

 

Wiki Index

Pages

Intranet Software