Loading ...

REST API: Get Child Spaces | Communifire Documentation

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

REST API: Get Child Spaces

0 
 /5
0 (0votes)

Get child spaces

GET /api/spaces/child

Finds all the spaces created under the parent space. 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.
ParentSpaceID &parentspaceid=x - Used in the request URL (see below) ID of the parent space whose child spaces are to be returned.
UserID &userid=x - Used in the request URL (see below) ID of the user whose spaces are to be returned.
FromCache &fromcache=x - Used in the request URL (see below) Specifies if the results are to be returned from cache.

Example URL to GET: https://your-community.com/api/spaces/child?parentspaceid=208&UserID=4&fromcache=false

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":209,
                            "ParentSpaceID":208,
                            "IsFeatured":false,
                            "Stub":null,
                            "LandingPage":null,
                            "TotalMembers":10,
                            "CreatedBy":1,
                            "UserID":0,
                            "SpaceName":"Fish",
                            "Author":null,
                            "Description":"A fish is any member of a paraphyletic group of organisms that consist of all gill-bearing aquatic craniate animals that lack limbs with digits.",
                            "UserName":"jhon",
                            "UserFirstName":"John",
                            "UserLastName":"Smith",
                            "UserEmail":"acme@acme.com",
                            "StatusID":1,
                            "MembershipType":0,
                            "SpaceVisibility":1,
                            "DateCreated":"2016-02-01T14:52:48.387",
                            "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":null,
                            "SpaceIconFileName":null,
                            "SpaceIconURL":null,
                            "MediaServerID":0,
                            "SpaceMediaServerRootURL":null,
                            "UserMediaServerRootURL":null,
                            "SpaceURL":null,
                            "UpdatedByUserID":0,
                            "InvitationExpiryInDays":0,
                            "DisableWallEmailNotifications":false,
                            "AutoSubscribeEmail":false,
                            "Image":null,
                            "SpaceImageURL":null,
                            "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