Loading ...

REST API: Get All Spaces | Communifire Documentation

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

REST API: Get All Spaces

0 
 /5
0 (0votes)

Get all spaces

GET /api/spaces

Fetches all the space objects relevant to the Status ID passed. 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.
Optional Parameters How to use Description
Status &Status=x - Used in the request URL as a query parameter Specifies the status of the spaces to be returned.
  • PendingWorkflow = 0
  • Published = 1
  • Declined = 3
  • All = 7
Visibility &Visibility=x - Used in the request URL as a query parameter Specifies the visibility of the spaces to be returned. All spaces are returned by default.
  • Private = 0
  • Public = 1
  • All = 2
GetNonMemberPublicSpacesOnly &GetNonMemberPublicSpacesOnly=x - Used in the request URL as a query parameter If true, only the spaces you're a member of and public spaces are returned. If false, all spaces are returned. True by default.

Example URL to GET: https://your-community.com/api/spaces?status=0

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":129,
                            "ParentSpaceID":0,
                            "IsFeatured":false,
                            "Stub":"development",
                            "LandingPage":null,
                            "TotalMembers":1,
                            "CreatedBy":1,
                            "UserID":1,
                            "SpaceName":"Development",
                            "Author":null,
                            "Description":"All activities related to development.",
                            "UserName":"jhon",
                            "UserFirstName":"Jhon",
                            "UserLastName":"Smith",
                            "UserEmail":"acme@acme.com",
                            "StatusID":0,
                            "MembershipType":0,
                            "SpaceVisibility":1,
                            "DateCreated":"2016-01-12T12:40:40.91",
                            "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/129/development",
                            "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
                        },
                        {
                            "SpaceID":186,
                            "ParentSpaceID":0,
                            "IsFeatured":false,
                            "Stub":"support",
                            "LandingPage":null,
                            "TotalMembers":1,
                            "CreatedBy":1,
                            "UserID":1,
                            "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":0,
                            "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