Phoenix Forum

Social collaboration platform

Comment

Comments are user generated comments threads on Topics.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of this entity[queryable][sortable]
ProjectIdSystem.Int32the Project that this entity belongs to[required]
TopicIdSystem.Int32 the Topic that this entity belongs to[queryable][sortable][required]
ParentCommentIdSystem.Int32Comments can be threaded.  The ParentComment is the Comment to which this entity is in reply to
StatusTypeIdStatusTypeEnum the Status of the Comment[queryable]
PhoenixIdentity_UserIdSystem.Int32 the user that created this Comment[queryable]
TextSystem.Stringthe comment that had been left by the user[required]
Rating_OverallSystem.Double how many times this comment has been disliked[sortable][required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
VoteCount_OverallSystem.Int32 how many times this comment has been liked[sortable][required]
AuthorSystem.Stringan optional name for the user who left the comment
ParentCommentCommentNavigation property to Comment [expandable]
ProjectProjectNavigation property to Project [expandable]
TopicTopicNavigation property to Topic [expandable]

Operations

CreateComment
Creates a new Comment object required to authenticate end usersSoapRestC#
GetComment
Returns a single CommentSoapRestC#
ListComment
Returns a paged list of Comments optionally filtered and sortedSoapRestC#
UpdateComment
Update an existing CommentSoapRestC#

DeleteResponse

Properties

Name Type Description

Operations

DeleteComment
Delete a Comment by it's IdSoapRestC#

Forum

Forums are collections of Topics and Comments.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of this entity[queryable][sortable]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
NameSystem.Stringthe Name given to this Forum[required]
MetaDataParametersList<KeyValuePair<string, string>>optional dictionary of key value pairs attached to this entity
DefaultCommentStatusTypeIdStatusTypeEnumthe default status given to new comments
ProjectIdSystem.Int32the Project that this entity belongs to[required]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateForum
Creates a new Forum object required to authenticate end usersSoapRestC#
GetForum
Returns a single ForumSoapRestC#
ListForum
Returns a paged list of Forums optionally filtered and sortedSoapRestC#

Project

A project is a logical separation of data.

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 refers to the master ProjectId in the PhoenixIdentity database[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Operations

ActivateModule
Description not availableSoapRestC#
DeactivateModule
Description not availableSoapRestC#
GetModuleSettings
Description not availableSoapRestC#
UpdateModuleSettings
Description not availableSoapRestC#

Topic

Topics group Comments together into particular themes.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of this entity[queryable][sortable]
ForumIdSystem.Int32 The Forum to which this Topic belongs to[queryable][required]
TopicTypeIdTopicTypeEnum What type of object the comments are attached to[queryable]
TargetIdSystem.Int32 The value of the object TopicType (ie ArticleId or MediaId)[queryable]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
NameSystem.String  The Name of the Topic[queryable][sortable][required]
ReferenceSystem.String An optional Reference that external systems can refer to this Topic by[queryable]
ForumForumNavigation property to Forum [expandable]

Operations

CreateTopic
Creates a new Topic object required to authenticate end usersSoapRestC#
GetTopic
Returns a single TopicSoapRestC#
ListTopic
Returns a paged list of Topics optionally filtered and sortedSoapRestC#
UpdateTopic
Update an existing TopicSoapRestC#