Loading ...

REST API: Space Overview | Communifire Documentation

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

REST API: Space Overview

0 
 /5
0 (0votes)

Space Properties

A space is a page created for an organization or business to promote activities, have personal conversations. It includes the Space ID that is used to make reference to the particular space throughout the system. Each Space ID is unique and automatically generated by the Communifire system. Spaces have the ability to message their members, as well as restrict who can and cannot join.

Description
Attributes Notes Data type
AutoSubscribeEmail If true, users joining the space will receive email messages from the space. bool
CreatedBy
 User ID of the user who created the space. int
DateCreated Date when the space was created. datetime
Description
 Short description about the space. string
DisableWallEmailNotifications If true, then no email messages will be sent out when someone posts a new wall message. bool
EnableArticles Set "articles" module on/off. bool
EnableBlogs
 Set "blogs" module on/off. bool
EnableContentReadConfirmation Set "content read" control on/off. bool
EnableEvents
 Set "events" module on/off. bool
EnableFileControl
 Set "file control" on/off. bool
EnableFiles
 Set "files" module on/off. bool
EnableForums
 Set "forums" module on/off. bool
EnableIssueTracker Set "issues" module on/off. bool
EnablePhotos Set "photos" module on/off. bool
EnableUpcomingBirthdaysControl Set "birthday" control on/off. bool
EnableVideos Set "videos" module on/off. bool
EnableWiki Set "wiki" module on/off. bool
GroupPictureFileName
 Name of the space main image file. string
Image The space image in bytes. byte[]
InvitationExpiryInDays Number of days in which the invitation will expire. int
IsArticleWorkflowActive Set "article" workflow on/off. bool
IsBlogWorkflowActive Set "blog" workflow on/off. bool
IsEventWorkflowActive Set "event" workflow on/off. bool
IsFileWorkflowActive Set "file" workflow on/off. bool
IsForumWorkflowActive Set "forum" workflow on/off. bool
IsPhotoWorkFlowActive
 Set "photo" workflow on/off. bool
IsVideoWorkFlowActive
 Set "video" workflow on/off. bool
IsWikiWorkflowActive
 Set "wiki" workflow on/off. string
LandingPage URL of the landing page of the space. string
MediaServerID
 Unique ID of the media server. int
MembershipType Specifies the space moderation. Accepted values are:
  • Unmoderated = 0
  • Moderated = 1
 SpaceMembershipType
ParentSpaceID Space ID of the parent space. int
SpaceIconFileName Name of the space icon file. string
SpaceIconURL URL of the space icon file. string
SpaceImageURL URL of the space image. string
SpaceID ID value which uniquely identifies each space in the Communifire. Generated automatically. This cannot be changed. int
SpaceMediaServerRootURL The uploaded files are saved at this URL location. string
SpaceName Name of space. string
SpaceURL URL of space. It can be used to reference the space directly. string
SpaceVisibility It defines the visibility of the space. Accepted values are:
  • Private = 0
  • Public = 1
  • All = 2
  • Isolated = 3
 SpaceVisibility
StatusID This is the status of the space. Accepted values are:
  • Pending workflow approval = 0
  • Published = 1
  • Declined = 3
 int
Stub Unique string generated by Communifire System based on the space name provided by the user. This stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
TotalMembers
 Total number of members of the space. int
UpdatedByUserID User ID of the user who last updated the space. int
UserEmail Email ID of the space author. string
UserFirstName First name of the space author. string
UserID User ID of the space author. int
UserLastName Last name of the space author. string
UserMediaServerRootURL The user uploaded files are saved at this location. string
UserName
 User name of the space author.  string

Please Note Refer this wiki on how to create a new space via REST API.

Wiki Index

Pages

Intranet Software