HomeREST APIForum

Forum

Create and manage forums, topics and replies.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/forum

Get all active forums

🔒Access — System admin

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Forums": [
    {
      "ForumId": 0,
      "ContentId": 0,
      "Section": {
        "SectionId": 0,
        "ParentId": 0,
        "Title": "string",
        "Description": "string",
        "Active": true
      },
      "ForumTitle": "string",
      "ForumSummary": "string",
      "PublishStartDate": "2024-01-01T00:00:00Z",
      "PublishEndDate": "2024-01-01T00:00:00Z",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Owner": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Keywords": [
        "string"
      ],
      "Watches": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Threads": [
        {
          "ThreadId": 0,
          "ForumId": 0,
          "Title": "string",
          "Description": "string",
          "Type": "Discussion",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          },
          "Posts": [
            {
              "PostId": 0,
              "ThreadId": 0,
              "PostText": "string",
              "AddedDate": "2024-01-01T00:00:00Z",
              "AddedBy": {
                "PersonId": 0,
                "FullName": "string",
                "FirstName": "string",
                "Surname": "string",
                "AssetId": 0,
                "ImageUrl": "string",
                "ProfileUrl": "string"
              },
              "Likes": [
                {
                  "PersonId": 0,
                  "FullName": "string",
                  "FirstName": "string",
                  "Surname": "string",
                  "AssetId": 0,
                  "ImageUrl": "string",
                  "ProfileUrl": "string"
                }
              ],
              "Shares": [
                {
                  "PersonId": 0,
                  "FullName": "string",
                  "FirstName": "string",
                  "Surname": "string",
                  "AssetId": 0,
                  "ImageUrl": "string",
                  "ProfileUrl": "string"
                }
              ],
              "Comments": [
                {
                  "CommentId": 0,
                  "PostId": 0,
                  "Comment": "string",
                  "AddedDate": "2024-01-01T00:00:00Z",
                  "AddedBy": {}
                }
              ],
              "LikesCount": 0,
              "SharesCount": 0,
              "CommentsCount": 0,
              "UpVotes": 0,
              "DownVotes": 0,
              "TotalVotes": 0,
              "IsAnonymous": true,
              "IsAnswer": true
            }
          ],
          "LatestPost": {
            "PostId": 0,
            "ThreadId": 0,
            "PostText": "string",
            "AddedDate": "2024-01-01T00:00:00Z",
            "AddedBy": {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            },
            "Likes": [
              {
                "PersonId": 0,
                "FullName": "string",
                "FirstName": "string",
                "Surname": "string",
                "AssetId": 0,
                "ImageUrl": "string",
                "ProfileUrl": "string"
              }
            ],
            "Shares": [
              {
                "PersonId": 0,
                "FullName": "string",
                "FirstName": "string",
                "Surname": "string",
                "AssetId": 0,
                "ImageUrl": "string",
                "ProfileUrl": "string"
              }
            ],
            "Comments": [
              {
                "CommentId": 0,
                "PostId": 0,
                "Comment": "string",
                "AddedDate": "2024-01-01T00:00:00Z",
                "AddedBy": {}
              }
            ],
            "LikesCount": 0,
            "SharesCount": 0,
            "CommentsCount": 0,
            "UpVotes": 0,
            "DownVotes": 0,
            "TotalVotes": 0,
            "IsAnonymous": true,
            "IsAnswer": true
          },
          "Keywords": [
            "string"
          ],
          "Likes": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Watches": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Shares": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "PostCount": 0,
          "UpVotes": 0,
          "DownVotes": 0,
          "TotalVotes": 0,
          "LikeCount": 0,
          "WatchCount": 0,
          "ShareCount": 0,
          "Icon": 0,
          "IsActive": true,
          "IsClosed": true,
          "IsSticky": true,
          "IsImplemented": true,
          "IsQuestion": true,
          "HasAnswer": true,
          "IsCommentsAllowed": true
        }
      ],
      "WatchCount": 0,
      "ThreadCount": 0,
      "AlertModerator": true,
      "AlertOnThread": true,
      "AllowAnonymous": true,
      "AllowAnonymousVoting": true,
      "AllowDiscussions": true,
      "AllowIdeas": true,
      "AllowQuestions": true,
      "AllowIdeasList": true,
      "ShowReplies": true,
      "IsActive": true
    }
  ]
}
FieldType
Forumsarray of object

GET /api/forum/{forumId}

Gets a forum by forum id

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ForumId": 0,
  "ContentId": 0,
  "Section": {
    "SectionId": 0,
    "ParentId": 0,
    "Title": "string",
    "Description": "string",
    "Active": true
  },
  "ForumTitle": "string",
  "ForumSummary": "string",
  "PublishStartDate": "2024-01-01T00:00:00Z",
  "PublishEndDate": "2024-01-01T00:00:00Z",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Owner": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Keywords": [
    "string"
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Threads": [
    {
      "ThreadId": 0,
      "ForumId": 0,
      "Title": "string",
      "Description": "string",
      "Type": "Discussion",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Posts": [
        {
          "PostId": 0,
          "ThreadId": 0,
          "PostText": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          },
          "Likes": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Shares": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Comments": [
            {
              "CommentId": 0,
              "PostId": 0,
              "Comment": "string",
              "AddedDate": "2024-01-01T00:00:00Z",
              "AddedBy": {
                "PersonId": 0,
                "FullName": "string",
                "FirstName": "string",
                "Surname": "string",
                "AssetId": 0,
                "ImageUrl": "string",
                "ProfileUrl": "string"
              }
            }
          ],
          "LikesCount": 0,
          "SharesCount": 0,
          "CommentsCount": 0,
          "UpVotes": 0,
          "DownVotes": 0,
          "TotalVotes": 0,
          "IsAnonymous": true,
          "IsAnswer": true
        }
      ],
      "LatestPost": {
        "PostId": 0,
        "ThreadId": 0,
        "PostText": "string",
        "AddedDate": "2024-01-01T00:00:00Z",
        "AddedBy": {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        },
        "Likes": [
          {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        ],
        "Shares": [
          {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        ],
        "Comments": [
          {
            "CommentId": 0,
            "PostId": 0,
            "Comment": "string",
            "AddedDate": "2024-01-01T00:00:00Z",
            "AddedBy": {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          }
        ],
        "LikesCount": 0,
        "SharesCount": 0,
        "CommentsCount": 0,
        "UpVotes": 0,
        "DownVotes": 0,
        "TotalVotes": 0,
        "IsAnonymous": true,
        "IsAnswer": true
      },
      "Keywords": [
        "string"
      ],
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Watches": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "PostCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "LikeCount": 0,
      "WatchCount": 0,
      "ShareCount": 0,
      "Icon": 0,
      "IsActive": true,
      "IsClosed": true,
      "IsSticky": true,
      "IsImplemented": true,
      "IsQuestion": true,
      "HasAnswer": true,
      "IsCommentsAllowed": true
    }
  ],
  "WatchCount": 0,
  "ThreadCount": 0,
  "AlertModerator": true,
  "AlertOnThread": true,
  "AllowAnonymous": true,
  "AllowAnonymousVoting": true,
  "AllowDiscussions": true,
  "AllowIdeas": true,
  "AllowQuestions": true,
  "AllowIdeasList": true,
  "ShowReplies": true,
  "IsActive": true
}
FieldType
ForumIdinteger (int32)
ContentIdinteger (int32)
Sectionobject
ForumTitlestring
ForumSummarystring
PublishStartDatestring (date-time)
PublishEndDatestring (date-time)
AddedDatestring (date-time)
AddedByobject
Ownerobject
Keywordsarray of string
Watchesarray of object
Threadsarray of object
WatchCountinteger (int32)
ThreadCountinteger (int32)
AlertModeratorboolean
AlertOnThreadboolean
AllowAnonymousboolean
AllowAnonymousVotingboolean
AllowDiscussionsboolean
AllowIdeasboolean
AllowQuestionsboolean
AllowIdeasListboolean
ShowRepliesboolean
IsActiveboolean

GET /api/forum/{forumId}/keyword

Get forum keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

GET /api/forum/{forumId}/moderator

Get forum moderators

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Moderators": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Moderatorsarray of object

GET /api/forum/{forumId}/participant

Get forum participants

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Participants": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Participantsarray of object

GET /api/forum/{forumId}/subscriber

Get forum subscribers

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Subscribers": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Subscribersarray of object

POST /api/forum/{forumId}/expert

Add experts to a forum

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Request body

{
  "ExpertIds": [
    0
  ]
}
FieldType
ExpertIdsarray of integer

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Experts": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Expertsarray of object

POST /api/forum/{forumId}/keyword

Add forum keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Request body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

POST /api/forum/{forumId}/moderator

Add moderators to forum

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Request body

{
  "Moderators": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Moderatorsarray of object

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Moderators": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Moderatorsarray of object

PUT /api/forum/{forumId}/subscribe

Subscribe to forum

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200
400
403
404

PUT /api/forum/{forumId}/subscribeteam

Subscribe a team to a forum

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/expert

Remove forum experts

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Experts": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Expertsarray of object

DELETE /api/forum/{forumId}/keyword

Remove forum keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

DELETE /api/forum/{forumId}/moderator

Remove forum moderators

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Moderators": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Moderatorsarray of object

DELETE /api/forum/{forumId}/unsubscribe

Unsubscribe from forum

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200
400
403
404

GET /api/forum/{forumId}/thread

Get all forum threads by forum id

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ForumId": 0,
  "SectionId": 0,
  "Active": true,
  "Title": "string",
  "Threads": [
    {
      "ThreadId": 0,
      "ForumId": 0,
      "Title": "string",
      "Description": "string",
      "Type": "Discussion",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Posts": [
        {
          "PostId": 0,
          "ThreadId": 0,
          "PostText": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          },
          "Likes": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Shares": [
            {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          ],
          "Comments": [
            {
              "CommentId": 0,
              "PostId": 0,
              "Comment": "string",
              "AddedDate": "2024-01-01T00:00:00Z",
              "AddedBy": {
                "PersonId": 0,
                "FullName": "string",
                "FirstName": "string",
                "Surname": "string",
                "AssetId": 0,
                "ImageUrl": "string",
                "ProfileUrl": "string"
              }
            }
          ],
          "LikesCount": 0,
          "SharesCount": 0,
          "CommentsCount": 0,
          "UpVotes": 0,
          "DownVotes": 0,
          "TotalVotes": 0,
          "IsAnonymous": true,
          "IsAnswer": true
        }
      ],
      "LatestPost": {
        "PostId": 0,
        "ThreadId": 0,
        "PostText": "string",
        "AddedDate": "2024-01-01T00:00:00Z",
        "AddedBy": {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        },
        "Likes": [
          {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        ],
        "Shares": [
          {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        ],
        "Comments": [
          {
            "CommentId": 0,
            "PostId": 0,
            "Comment": "string",
            "AddedDate": "2024-01-01T00:00:00Z",
            "AddedBy": {
              "PersonId": 0,
              "FullName": "string",
              "FirstName": "string",
              "Surname": "string",
              "AssetId": 0,
              "ImageUrl": "string",
              "ProfileUrl": "string"
            }
          }
        ],
        "LikesCount": 0,
        "SharesCount": 0,
        "CommentsCount": 0,
        "UpVotes": 0,
        "DownVotes": 0,
        "TotalVotes": 0,
        "IsAnonymous": true,
        "IsAnswer": true
      },
      "Keywords": [
        "string"
      ],
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Watches": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "PostCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "LikeCount": 0,
      "WatchCount": 0,
      "ShareCount": 0,
      "Icon": 0,
      "IsActive": true,
      "IsClosed": true,
      "IsSticky": true,
      "IsImplemented": true,
      "IsQuestion": true,
      "HasAnswer": true,
      "IsCommentsAllowed": true
    }
  ]
}
FieldType
ForumIdinteger (int32)
SectionIdinteger (int32)
Activeboolean
Titlestring
Threadsarray of object

GET /api/forum/{forumId}/thread/{threadId}

Gets a forum thread by its id

Parameters

Name In Type Required Description
threadId path integer (int32) Yes
forumId path string Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ThreadId": 0,
  "ForumId": 0,
  "Title": "string",
  "Description": "string",
  "Type": "Discussion",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Posts": [
    {
      "PostId": 0,
      "ThreadId": 0,
      "PostText": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Comments": [
        {
          "CommentId": 0,
          "PostId": 0,
          "Comment": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        }
      ],
      "LikesCount": 0,
      "SharesCount": 0,
      "CommentsCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "IsAnonymous": true,
      "IsAnswer": true
    }
  ],
  "LatestPost": {
    "PostId": 0,
    "ThreadId": 0,
    "PostText": "string",
    "AddedDate": "2024-01-01T00:00:00Z",
    "AddedBy": {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    },
    "Likes": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Shares": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": 0,
        "PostId": 0,
        "Comment": "string",
        "AddedDate": "2024-01-01T00:00:00Z",
        "AddedBy": {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      }
    ],
    "LikesCount": 0,
    "SharesCount": 0,
    "CommentsCount": 0,
    "UpVotes": 0,
    "DownVotes": 0,
    "TotalVotes": 0,
    "IsAnonymous": true,
    "IsAnswer": true
  },
  "Keywords": [
    "string"
  ],
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "PostCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "LikeCount": 0,
  "WatchCount": 0,
  "ShareCount": 0,
  "Icon": 0,
  "IsActive": true,
  "IsClosed": true,
  "IsSticky": true,
  "IsImplemented": true,
  "IsQuestion": true,
  "HasAnswer": true,
  "IsCommentsAllowed": true
}
FieldType
ThreadIdinteger (int32)
ForumIdinteger (int32)
Titlestring
Descriptionstring
Typestring
AddedDatestring (date-time)
AddedByobject
Postsarray of object
LatestPostobject
Keywordsarray of string
Likesarray of object
Watchesarray of object
Sharesarray of object
PostCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
LikeCountinteger (int32)
WatchCountinteger (int32)
ShareCountinteger (int32)
Iconinteger (int32)
IsActiveboolean
IsClosedboolean
IsStickyboolean
IsImplementedboolean
IsQuestionboolean
HasAnswerboolean
IsCommentsAllowedboolean

GET /api/forum/{forumId}/thread/{threadId}/attachment

Get the attachment paths for the specified forum thread.

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

[
  {
    "AttachmentId": 0,
    "FileGuid": "string",
    "Path": "string",
    "Title": "string",
    "Size": 0,
    "Extension": "string",
    "AssetId": 0,
    "SortOrder": 0
  }
]
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/attachment/{attachmentGuid}

Get an attachment from a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
attachmentGuid path string Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "AttachmentId": 0,
  "FileGuid": "string",
  "Path": "string",
  "Title": "string",
  "Size": 0,
  "Extension": "string",
  "AssetId": 0,
  "SortOrder": 0
}
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/expert

Gets a lists of suggested forum experts by threadId

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Experts": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Expertsarray of object

GET /api/forum/{forumId}/thread/{threadId}/forumexpert

Get forum suggested experts

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Experts": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Expertsarray of object

GET /api/forum/{forumId}/thread/{threadId}/keyword

Get thread keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

GET /api/forum/{forumId}/thread/{threadId}/like

Get likes for a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Count": 0,
  "CurrentUserLiked": true,
  "Likes": [
    {
      "LikeDate": "2024-01-01T00:00:00Z",
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Countinteger (int32)
CurrentUserLikedboolean
Likesarray of object

GET /api/forum/{forumId}/thread/{threadId}/participant

Get participants

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Participants": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Participantsarray of object

GET /api/forum/{forumId}/thread/{threadId}/personvote

Get person thread vote

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/post

Get all posts in a thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ThreadId": 0,
  "SectionId": 0,
  "Active": true,
  "Title": "string",
  "Posts": [
    {
      "PostId": 0,
      "ThreadId": 0,
      "PostText": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Comments": [
        {
          "CommentId": 0,
          "PostId": 0,
          "Comment": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        }
      ],
      "LikesCount": 0,
      "SharesCount": 0,
      "CommentsCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "IsAnonymous": true,
      "IsAnswer": true
    }
  ]
}
FieldType
ThreadIdinteger (int32)
SectionIdinteger (int32)
Activeboolean
Titlestring
Postsarray of object

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}

Get a post by id

Parameters

Name In Type Required Description
postId path integer (int32) Yes
forumId path string Yes
threadId path string Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ],
  "LikesCount": 0,
  "SharesCount": 0,
  "CommentsCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
AddedDatestring (date-time)
AddedByobject
Likesarray of object
Sharesarray of object
Commentsarray of object
LikesCountinteger (int32)
SharesCountinteger (int32)
CommentsCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
IsAnonymousboolean
IsAnswerboolean

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/attachment

Get the attachment paths for the specified forum post.

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

[
  {
    "AttachmentId": 0,
    "FileGuid": "string",
    "Path": "string",
    "Title": "string",
    "Size": 0,
    "Extension": "string",
    "AssetId": 0,
    "SortOrder": 0
  }
]
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/attachment/{attachmentGuid}

Get an attachment from a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
attachmentGuid path string Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "AttachmentId": 0,
  "FileGuid": "string",
  "Path": "string",
  "Title": "string",
  "Size": 0,
  "Extension": "string",
  "AssetId": 0,
  "SortOrder": 0
}
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment

Get all comments in a post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ]
}
FieldType
Commentsarray of object

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}

Get a comment by id

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "CommentId": 0,
  "PostId": 0,
  "Comment": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  }
}
FieldType
CommentIdinteger (int32)
PostIdinteger (int32)
Commentstring
AddedDatestring (date-time)
AddedByobject

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}/like

Get likes for a forum post comment

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Count": 0,
  "CurrentUserLiked": true,
  "Likes": [
    {
      "LikeDate": "2024-01-01T00:00:00Z",
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Countinteger (int32)
CurrentUserLikedboolean
Likesarray of object

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/like

Get likes for a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Count": 0,
  "CurrentUserLiked": true,
  "Likes": [
    {
      "LikeDate": "2024-01-01T00:00:00Z",
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Countinteger (int32)
CurrentUserLikedboolean
Likesarray of object

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/personvote

Get person post vote

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/share

Get post shares

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ActionId": 0,
  "Comment": "string",
  "People": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
ActionIdinteger (int32)
Commentstring
Peoplearray of object

GET /api/forum/{forumId}/thread/{threadId}/post/{postId}/vote

Get post votes

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

GET /api/forum/{forumId}/thread/{threadId}/share

Get thread shares

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ActionId": 0,
  "Comment": "string",
  "People": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
ActionIdinteger (int32)
Commentstring
Peoplearray of object

GET /api/forum/{forumId}/thread/{threadId}/subscriber

Get thread subscribers

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Subscribers": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Subscribersarray of object

GET /api/forum/{forumId}/thread/{threadId}/vote

Get forum votes

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

POST /api/forum/{forumId}/thread

Create a new forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes

Request body

{
  "ThreadId": 0,
  "ForumId": 0,
  "Title": "string",
  "Description": "string",
  "Type": "Discussion",
  "Keywords": [
    "string"
  ],
  "Experts": [
    0
  ],
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "IsActive": true,
  "IsSticky": true,
  "IsCommentsAllowed": true
}
FieldType
ThreadIdinteger (int32)
ForumIdinteger (int32)
Titlestring
Descriptionstring
Typestring
Keywordsarray of string
Expertsarray of integer
Likesarray of object
Watchesarray of object
Sharesarray of object
IsActiveboolean
IsStickyboolean
IsCommentsAllowedboolean

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ThreadId": 0,
  "ForumId": 0,
  "Title": "string",
  "Description": "string",
  "Type": "Discussion",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Posts": [
    {
      "PostId": 0,
      "ThreadId": 0,
      "PostText": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Comments": [
        {
          "CommentId": 0,
          "PostId": 0,
          "Comment": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        }
      ],
      "LikesCount": 0,
      "SharesCount": 0,
      "CommentsCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "IsAnonymous": true,
      "IsAnswer": true
    }
  ],
  "LatestPost": {
    "PostId": 0,
    "ThreadId": 0,
    "PostText": "string",
    "AddedDate": "2024-01-01T00:00:00Z",
    "AddedBy": {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    },
    "Likes": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Shares": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": 0,
        "PostId": 0,
        "Comment": "string",
        "AddedDate": "2024-01-01T00:00:00Z",
        "AddedBy": {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      }
    ],
    "LikesCount": 0,
    "SharesCount": 0,
    "CommentsCount": 0,
    "UpVotes": 0,
    "DownVotes": 0,
    "TotalVotes": 0,
    "IsAnonymous": true,
    "IsAnswer": true
  },
  "Keywords": [
    "string"
  ],
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "PostCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "LikeCount": 0,
  "WatchCount": 0,
  "ShareCount": 0,
  "Icon": 0,
  "IsActive": true,
  "IsClosed": true,
  "IsSticky": true,
  "IsImplemented": true,
  "IsQuestion": true,
  "HasAnswer": true,
  "IsCommentsAllowed": true
}
FieldType
ThreadIdinteger (int32)
ForumIdinteger (int32)
Titlestring
Descriptionstring
Typestring
AddedDatestring (date-time)
AddedByobject
Postsarray of object
LatestPostobject
Keywordsarray of string
Likesarray of object
Watchesarray of object
Sharesarray of object
PostCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
LikeCountinteger (int32)
WatchCountinteger (int32)
ShareCountinteger (int32)
Iconinteger (int32)
IsActiveboolean
IsClosedboolean
IsStickyboolean
IsImplementedboolean
IsQuestionboolean
HasAnswerboolean
IsCommentsAllowedboolean

POST /api/forum/{forumId}/thread/{threadId}/attachment

Upload an attachment for a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

[
  {
    "AttachmentId": 0,
    "FileGuid": "string",
    "Path": "string",
    "Title": "string",
    "Size": 0,
    "Extension": "string",
    "AssetId": 0,
    "SortOrder": 0
  }
]
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

POST /api/forum/{forumId}/thread/{threadId}/invite

Send thread invitations

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "Users": [
    0
  ],
  "Comment": "string"
}
FieldType
Usersarray of integer
Commentstring

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Users": [
    0
  ],
  "Comment": "string"
}
FieldType
Usersarray of integer
Commentstring

POST /api/forum/{forumId}/thread/{threadId}/keyword

Add thread keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

POST /api/forum/{forumId}/thread/{threadId}/post

Create a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
IsAnonymousboolean
IsAnswerboolean

Responses

Status Body
200 See below
400
403
404

Response body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ],
  "LikesCount": 0,
  "SharesCount": 0,
  "CommentsCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
AddedDatestring (date-time)
AddedByobject
Likesarray of object
Sharesarray of object
Commentsarray of object
LikesCountinteger (int32)
SharesCountinteger (int32)
CommentsCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
IsAnonymousboolean
IsAnswerboolean

POST /api/forum/{forumId}/thread/{threadId}/post/{postId}/attachment

Upload an attachment for a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

[
  {
    "AttachmentId": 0,
    "FileGuid": "string",
    "Path": "string",
    "Title": "string",
    "Size": 0,
    "Extension": "string",
    "AssetId": 0,
    "SortOrder": 0
  }
]
FieldType
AttachmentIdinteger (int32)
FileGuidstring
Pathstring
Titlestring
Sizeinteger (int32)
Extensionstring
AssetIdinteger (int32)
SortOrderinteger (int32)

POST /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment

Create a post comment

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Request body

{
  "CommentId": 0,
  "PostId": 0,
  "Comment": "string"
}
FieldType
CommentIdinteger (int32)
PostIdinteger (int32)
Commentstring

Responses

Status Body
200 See below
400
403
404

Response body

{
  "CommentId": 0,
  "PostId": 0,
  "Comment": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  }
}
FieldType
CommentIdinteger (int32)
PostIdinteger (int32)
Commentstring
AddedDatestring (date-time)
AddedByobject

POST /api/forum/{forumId}/thread/{threadId}/post/{postId}/share

Share a forum post

Parameters

Name In Type Required Description
postId path integer (int32) Yes
forumId path string Yes
threadId path string Yes

Request body

"string"

No documented fields.

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ActionId": 0,
  "Comment": "string",
  "People": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
ActionIdinteger (int32)
Commentstring
Peoplearray of object

POST /api/forum/{forumId}/thread/{threadId}/share

Share a forum thread

Parameters

Name In Type Required Description
threadId path integer (int32) Yes
forumId path string Yes

Request body

"string"

No documented fields.

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ActionId": 0,
  "Comment": "string",
  "People": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
ActionIdinteger (int32)
Commentstring
Peoplearray of object

PUT /api/forum/{forumId}/thread/{threadId}

Update a thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "ThreadId": 0,
  "ForumId": 0,
  "Title": "string",
  "Description": "string",
  "Type": "Discussion",
  "Keywords": [
    "string"
  ],
  "Experts": [
    0
  ],
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "IsActive": true,
  "IsSticky": true,
  "IsCommentsAllowed": true
}
FieldType
ThreadIdinteger (int32)
ForumIdinteger (int32)
Titlestring
Descriptionstring
Typestring
Keywordsarray of string
Expertsarray of integer
Likesarray of object
Watchesarray of object
Sharesarray of object
IsActiveboolean
IsStickyboolean
IsCommentsAllowedboolean

Responses

Status Body
200 See below
400
403
404

Response body

{
  "ThreadId": 0,
  "ForumId": 0,
  "Title": "string",
  "Description": "string",
  "Type": "Discussion",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Posts": [
    {
      "PostId": 0,
      "ThreadId": 0,
      "PostText": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      },
      "Likes": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Shares": [
        {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      ],
      "Comments": [
        {
          "CommentId": 0,
          "PostId": 0,
          "Comment": "string",
          "AddedDate": "2024-01-01T00:00:00Z",
          "AddedBy": {
            "PersonId": 0,
            "FullName": "string",
            "FirstName": "string",
            "Surname": "string",
            "AssetId": 0,
            "ImageUrl": "string",
            "ProfileUrl": "string"
          }
        }
      ],
      "LikesCount": 0,
      "SharesCount": 0,
      "CommentsCount": 0,
      "UpVotes": 0,
      "DownVotes": 0,
      "TotalVotes": 0,
      "IsAnonymous": true,
      "IsAnswer": true
    }
  ],
  "LatestPost": {
    "PostId": 0,
    "ThreadId": 0,
    "PostText": "string",
    "AddedDate": "2024-01-01T00:00:00Z",
    "AddedBy": {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    },
    "Likes": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Shares": [
      {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": 0,
        "PostId": 0,
        "Comment": "string",
        "AddedDate": "2024-01-01T00:00:00Z",
        "AddedBy": {
          "PersonId": 0,
          "FullName": "string",
          "FirstName": "string",
          "Surname": "string",
          "AssetId": 0,
          "ImageUrl": "string",
          "ProfileUrl": "string"
        }
      }
    ],
    "LikesCount": 0,
    "SharesCount": 0,
    "CommentsCount": 0,
    "UpVotes": 0,
    "DownVotes": 0,
    "TotalVotes": 0,
    "IsAnonymous": true,
    "IsAnswer": true
  },
  "Keywords": [
    "string"
  ],
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Watches": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "PostCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "LikeCount": 0,
  "WatchCount": 0,
  "ShareCount": 0,
  "Icon": 0,
  "IsActive": true,
  "IsClosed": true,
  "IsSticky": true,
  "IsImplemented": true,
  "IsQuestion": true,
  "HasAnswer": true,
  "IsCommentsAllowed": true
}
FieldType
ThreadIdinteger (int32)
ForumIdinteger (int32)
Titlestring
Descriptionstring
Typestring
AddedDatestring (date-time)
AddedByobject
Postsarray of object
LatestPostobject
Keywordsarray of string
Likesarray of object
Watchesarray of object
Sharesarray of object
PostCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
LikeCountinteger (int32)
WatchCountinteger (int32)
ShareCountinteger (int32)
Iconinteger (int32)
IsActiveboolean
IsClosedboolean
IsStickyboolean
IsImplementedboolean
IsQuestionboolean
HasAnswerboolean
IsCommentsAllowedboolean

PUT /api/forum/{forumId}/thread/{threadId}/addvote

Add thread vote

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "VoteId": 0,
  "ThreadId": 0,
  "PostId": 0,
  "Direction": 0,
  "PersonId": 0,
  "UpVote": 0,
  "DownVote": 0
}
FieldType
VoteIdinteger (int32)
ThreadIdinteger (int32)
PostIdinteger (int32)
Directioninteger (int32)
PersonIdinteger (int32)
UpVoteinteger (int32)
DownVoteinteger (int32)

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

PUT /api/forum/{forumId}/thread/{threadId}/close

Update a close.

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404

PUT /api/forum/{forumId}/thread/{threadId}/like

Like a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}

Update a post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Request body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
IsAnonymousboolean
IsAnswerboolean

Responses

Status Body
200 See below
400
403
404

Response body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ],
  "LikesCount": 0,
  "SharesCount": 0,
  "CommentsCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
AddedDatestring (date-time)
AddedByobject
Likesarray of object
Sharesarray of object
Commentsarray of object
LikesCountinteger (int32)
SharesCountinteger (int32)
CommentsCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
IsAnonymousboolean
IsAnswerboolean

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}/addvote

Add post vote

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Request body

{
  "VoteId": 0,
  "ThreadId": 0,
  "PostId": 0,
  "Direction": 0,
  "PersonId": 0,
  "UpVote": 0,
  "DownVote": 0
}
FieldType
VoteIdinteger (int32)
ThreadIdinteger (int32)
PostIdinteger (int32)
Directioninteger (int32)
PersonIdinteger (int32)
UpVoteinteger (int32)
DownVoteinteger (int32)

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}/answer

Mark post as answer

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ],
  "LikesCount": 0,
  "SharesCount": 0,
  "CommentsCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
AddedDatestring (date-time)
AddedByobject
Likesarray of object
Sharesarray of object
Commentsarray of object
LikesCountinteger (int32)
SharesCountinteger (int32)
CommentsCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
IsAnonymousboolean
IsAnswerboolean

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}

Update a post comment

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Request body

{
  "CommentId": 0,
  "PostId": 0,
  "Comment": "string"
}
FieldType
CommentIdinteger (int32)
PostIdinteger (int32)
Commentstring

Responses

Status Body
200 See below
400
403
404

Response body

{
  "CommentId": 0,
  "PostId": 0,
  "Comment": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  }
}
FieldType
CommentIdinteger (int32)
PostIdinteger (int32)
Commentstring
AddedDatestring (date-time)
AddedByobject

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}/like

Like a forum post comment

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Responses

Status Body
200
400
403
404

PUT /api/forum/{forumId}/thread/{threadId}/post/{postId}/like

Like a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200
400
403
404

PUT /api/forum/{forumId}/thread/{threadId}/subscribe

Subscribe to thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/attachment

Deletes all attachments for a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/attachment/{attachmentGuid}

Deletes an attachment from forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
attachmentGuid path string Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/close

Delete a close.

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/keyword

Remove thread keywords

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Keywords": [
    "string"
  ]
}
FieldType
Keywordsarray of string

DELETE /api/forum/{forumId}/thread/{threadId}/like

Unlike a forum thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "Count": 0,
  "CurrentUserLiked": true,
  "Likes": [
    {
      "LikeDate": "2024-01-01T00:00:00Z",
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ]
}
FieldType
Countinteger (int32)
CurrentUserLikedboolean
Likesarray of object

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}

Delete a post from a thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/answer

Unmark post as answer

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200 See below
400
403
404

Response body

{
  "PostId": 0,
  "ThreadId": 0,
  "PostText": "string",
  "AddedDate": "2024-01-01T00:00:00Z",
  "AddedBy": {
    "PersonId": 0,
    "FullName": "string",
    "FirstName": "string",
    "Surname": "string",
    "AssetId": 0,
    "ImageUrl": "string",
    "ProfileUrl": "string"
  },
  "Likes": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Shares": [
    {
      "PersonId": 0,
      "FullName": "string",
      "FirstName": "string",
      "Surname": "string",
      "AssetId": 0,
      "ImageUrl": "string",
      "ProfileUrl": "string"
    }
  ],
  "Comments": [
    {
      "CommentId": 0,
      "PostId": 0,
      "Comment": "string",
      "AddedDate": "2024-01-01T00:00:00Z",
      "AddedBy": {
        "PersonId": 0,
        "FullName": "string",
        "FirstName": "string",
        "Surname": "string",
        "AssetId": 0,
        "ImageUrl": "string",
        "ProfileUrl": "string"
      }
    }
  ],
  "LikesCount": 0,
  "SharesCount": 0,
  "CommentsCount": 0,
  "UpVotes": 0,
  "DownVotes": 0,
  "TotalVotes": 0,
  "IsAnonymous": true,
  "IsAnswer": true
}
FieldType
PostIdinteger (int32)
ThreadIdinteger (int32)
PostTextstring
AddedDatestring (date-time)
AddedByobject
Likesarray of object
Sharesarray of object
Commentsarray of object
LikesCountinteger (int32)
SharesCountinteger (int32)
CommentsCountinteger (int32)
UpVotesinteger (int32)
DownVotesinteger (int32)
TotalVotesinteger (int32)
IsAnonymousboolean
IsAnswerboolean

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/attachment

Deletes all attachments for a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/attachment/{attachmentGuid}

Deletes an attachment from a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
attachmentGuid path string Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}

Delete a comment on a post by id

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/comment/{commentId}/like

Unlike a forum post comment

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes
commentId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/like

Unlike a forum post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Responses

Status Body
200
400
403
404

DELETE /api/forum/{forumId}/thread/{threadId}/post/{postId}/removevote

Remove vote from post

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes
postId path integer (int32) Yes

Request body

{
  "VoteId": 0,
  "ThreadId": 0,
  "PostId": 0,
  "Direction": 0,
  "PersonId": 0,
  "UpVote": 0,
  "DownVote": 0
}
FieldType
VoteIdinteger (int32)
ThreadIdinteger (int32)
PostIdinteger (int32)
Directioninteger (int32)
PersonIdinteger (int32)
UpVoteinteger (int32)
DownVoteinteger (int32)

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

DELETE /api/forum/{forumId}/thread/{threadId}/removevote

Remove vote from thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Request body

{
  "VoteId": 0,
  "ThreadId": 0,
  "PostId": 0,
  "Direction": 0,
  "PersonId": 0,
  "UpVote": 0,
  "DownVote": 0
}
FieldType
VoteIdinteger (int32)
ThreadIdinteger (int32)
PostIdinteger (int32)
Directioninteger (int32)
PersonIdinteger (int32)
UpVoteinteger (int32)
DownVoteinteger (int32)

Responses

Status Body
200 See below
400
403
404

Response body

{
  "UpVote": 0,
  "DownVote": 0,
  "Total": 0
}
FieldType
UpVoteinteger (int32)
DownVoteinteger (int32)
Totalinteger (int32)

DELETE /api/forum/{forumId}/thread/{threadId}/unsubscribe

Unsubscribe from thread

Parameters

Name In Type Required Description
forumId path integer (int32) Yes
threadId path integer (int32) Yes

Responses

Status Body
200
400
403
404
Section: REST API