Loading ...

REST API: Get Forums | Communifire Documentation

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

REST API: Get Forums

0 
 /5
0 (0votes)

Get Forums

GET /api/content/list

Get a list of forums. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
EntityType &EntityType=x - Used in the request URL as a query parameter Entity Type for forum is 1.
SpaceID &SpaceID=x - Used in the request URL as a query parameter Unique ID of a space.
UserID &UserID=x - Used in the request URL as a query parameter Unique ID of the user whose forums are to be returned.
EntityStatus &EntityStatus=x - Used in the request URL as a query parameter Specifies the status of the forums to be returned.
  • Non Active = 3
  • Active = 1

NOTE: If status is passed as NULL then all the forum groups are returned.
SortColumn &SortColumn=x - Used in the request URL as a query parameter Sort content based on a column. Here are the values of Sort Column parameter:
  • Unspecified = 0
  • DateCreated = 1
  • DatePublished = 3
  • DateUpdated = 4
  • SortOrder = 8
  • ContentTitle = 10
  • MostRelavant = 13
SortOrder &SortOrder=x - Used in the request URL as a query parameter The order in which content is to be sorted. Here are the values of Sort Order parameter:
  • Ascending = 0
  • Descending = 1
  • Unspecified = 2
DatePublishedTime &DatePublishedTime=x - Used in the request URL as a query parameter Returns content that was published before the specified date time.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET
https://myintranet.communifire.com/api/content/list?EntityType=1&UserID=1&SpaceID=0&EntityStatus=1&SortColumn=1&SortOrder=0&StartPage=1&PageLength=3

Example Response

Forum JSON objects are returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":[
            {
            "ContentMediaBytes":null,
            "ContentID":782,
            "EntityType":1,
            "ContentTypeID":1,
            "ContentTitle":"Venus Facts",
            "ContentStub":"venus-facts",
            "ContentBody":"Venus is the second planet from the Sun, orbiting it every 224.7 Earth days. It has no natural satellite. It is named after the Roman goddess of love and beauty. After the Moon, it is the brightest natural object in the night sky, reaching an apparent magnitude of −4.6, bright enough to cast shadows.",
            "AuthorID":1,
            "AuthorUserName":"jon",
            "UpdatedByUserID":1,
            "UpdatedByUserDisplayName":"Jon Smith",
            "ParentContentID":4,
            "ContentVersionID":1,
            "SpaceID":0,
            "WorkflowID":0,
            "CurrentWorkflowStepID":0,
            "StatusID":1,
            "ContentStageID":null,
            "ContentStageName":null,
            "DateCreated":"2016-01-25T13:02:40.237",
            "DatePublished":"2016-01-25T13:02:40.237",
            "DateUpdated":"2016-01-25T13:02:40.237",
            "IsFeatured":false,
            "SpaceName":null,
            "SpaceURL":null,
            "AuthorDisplayName":"Jon Smith",
            "AuthorEmail":"acme@acme.com",
            "AuthorFirstName":"Jon",
            "AuthorLastName":"Smith",
            "AuthorProfileUrl":"https://myintranet.communifire.com/people/jon",
            "LockedByUserProfileUrl":null,
            "LockedByUserDisplayName":null,
            "IsLatest":false,
            "DateCreatedString":"15 minutes ago",
            "DatePublishedString":"15 minutes ago",
            "DateUpdatedString":"15 minutes ago",
            "ContentURL":"/forums/782/venus-facts"
        },
        {
            "ContentMediaBytes":null,
            "ContentID":23,
            "EntityType":1,
            "ContentTypeID":1,
            "ContentTitle":"Mars Facts",
            "ContentStub":"mars-facts",
            "ContentBody":"Mars is the fourth planet from the Sun and the second smallest planet in the Solar System, after Mercury. Mars is a terrestrial planet with a thin atmosphere, having surface features reminiscent both of the impact craters of the Moon and the valleys, deserts, and polar ice caps of Earth.",
            "AuthorID":1,
            "AuthorUserName":"jon",
            "UpdatedByUserID":1,
            "UpdatedByUserDisplayName":"Jon Smith",
            "ParentContentID":4,
            "ContentVersionID":1,
            "SpaceID":0,
            "WorkflowID":0,
            "CurrentWorkflowStepID":0,
            "StatusID":1,
            "ContentStageID":null,
            "ContentStageName":null,
            "DateCreated":"2016-01-25T13:00:19.193",
            "DatePublished":"2016-01-25T13:00:19.193",
            "DateUpdated":"2016-01-25T13:00:19.193",
            "IsFeatured":false,
            "SpaceName":null,
            "SpaceURL":null,
            "AuthorDisplayName":"Jon Smith",
            "AuthorEmail":"acme@acme.com",
            "AuthorFirstName":"Jon",
            "AuthorLastName":"Smith",
            "AuthorProfileUrl":"https://myintranet.communifire.com/people/jon",
            "LockedByUserProfileUrl":null,
            "LockedByUserDisplayName":null,
            "IsLatest":false,
            "TagsCSV":null,
            "TagsIDCSV":null,
            "DateCreatedString":"17 minutes ago",
            "DatePublishedString":"17 minutes ago",
            "DateUpdatedString":"17 minutes ago",
            "ContentURL":"/forums/23/mars-facts"
        },
        {
            "ContentMediaBytes":null,
            "ContentID":234,
            "EntityType":1,
            "ContentTypeID":1,
            "ContentTitle":"Jupiter Facts",
            "ContentStub":"jupiter-facts",
            "ContentBody":"Jupiter is the fifth planet from the Sun and the largest in the Solar System. It is a giant planet with a mass one-thousandth that of the Sun, but two and a half times that of all the other planets in the Solar System combined.",
            "AuthorID":1,
            "AuthorUserName":"jon",
            "UpdatedByUserID":1,
            "UpdatedByUserDisplayName":"Jon Smith",
            "ParentContentID":5,
            "ContentVersionID":1,
            "SpaceID":0,
            "WorkflowID":0,
            "CurrentWorkflowStepID":0,
            "StatusID":1,
            "ContentStageID":null,
            "ContentStageName":null,
            "DateCreated":"2016-01-25T09:30:10.7",
            "DatePublished":"2016-01-25T09:30:10.7",
            "DateUpdated":"2016-01-25T09:30:10.7",
            "IsFeatured":false,
            "SpaceName":null,
            "SpaceURL":null,
            "AuthorDisplayName":"Jon Smith",
            "AuthorEmail":"acme@acme.com",
            "AuthorFirstName":"Jon",
            "AuthorLastName":"Smith",
            "AuthorProfileUrl":"https://myintranet.communifire.com/people/jon",
            "LockedByUserProfileUrl":null,
            "LockedByUserDisplayName":null,
            "IsLatest":false,
            "DateCreatedString":"7 seconds ago",
            "DatePublishedString":"7 seconds ago",
            "DateUpdatedString":"7 seconds ago",
            "ContentURL":"/forums/234/jupiter-facts"
        }
    ] 
}


Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software