List Forum REST Endpoint - Telligent Evolution 7.x Developer Documentation - Developer Space

URLs

GET api.ashx/v2/forums.xml (or .json)

LIST forums.

GET api.ashx/v2/groups/{groupid}/forums.xml (or .json)

LIST forums.

Request Parameters

Name	Type	Description	Required
GroupId	`int?`	Group Id	Optional
IncludeSubGroups	`bool?`	Only used when GroupId is specified. Default is false.	Optional
SortBy	`string`	Options are: DateCreated, LastPost, Name, Post, SortOrder, Thread, TotalPosts, Score:SCORE_ID. Default is SortOrder.	Optional
SortOrder	`string`	Options include Ascending, Descending. Default is Ascending.	Optional
PageSize	`int?`	Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional
PageIndex	`int?`	Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	Optional

Example Requests

.Net (C#)

var webClient = new WebClient();

// replace the "admin" and "Admin's API key" with your valid user and apikey!
var adminKey = String.Format("{0}:{1}", "Admin's API Key", "admin");
var adminKeyBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(adminKey);

webClient.Headers.Add("Rest-User-Token", adminKeyBase64);
var requestUrl = "http://mysite.com/api.ashx/v2/forums.xml";

var xml = webClient.DownloadString(requestUrl));

Console.WriteLine(xml);

Widget Javascript

jQuery.telligent.evolution.get({
   url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/forums.json',
   success: function(response) {

   }
});

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Forums PageSize="2" PageIndex="0" TotalCount="2">
    <Forum>
      <Id>52</Id>
      <Name>title</Name>
      <Url>url</Url>
      <Group>
        <Id>4</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-01-04T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>6</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>25</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>8</GroupCount>
        <GroupType>Joinless</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
        <Container>
          <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
          <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <DateCreated>2012-05-02T00:00:00</DateCreated>
      <LatestPostDate>2012-06-04T00:00:00</LatestPostDate>
      <Description>description</Description>
      <AllowedThreadTypes>
        <ThreadType>value</ThreadType>
        <ThreadType>value</ThreadType>
      </AllowedThreadTypes>
      <DefaultThreadType>defaultthreadtype</DefaultThreadType>
      <Enabled>true</Enabled>
      <IndexPosts>true</IndexPosts>
      <ModeratePosts>true</ModeratePosts>
      <EnableModerationNotifications>true</EnableModerationNotifications>
      <EnablePostStatistics>true</EnablePostStatistics>
      <EnablePostPoints>true</EnablePostPoints>
      <PostsToModerate>7</PostsToModerate>
      <ThreadCount>27</ThreadCount>
      <ReplyCount>32</ReplyCount>
      <EmailAddress>emailaddress</EmailAddress>
      <EnableAnonymousPosting>true</EnableAnonymousPosting>
      <DefaultThreadStatus>defaultthreadstatus</DefaultThreadStatus>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <Application>
        <ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId>
        <ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Container>
          <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
          <ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Application>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
    </Forum>
    <Forum>
      <Id>8</Id>
      <Name>title</Name>
      <Url>url</Url>
      <Group>
        <Id>18</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2011-05-28T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>19</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>112</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>61</GroupCount>
        <GroupType>Joinless</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
        <Container>
          <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
          <ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <DateCreated>2011-12-09T00:00:00</DateCreated>
      <LatestPostDate>2012-03-29T00:00:00</LatestPostDate>
      <Description>description</Description>
      <AllowedThreadTypes>
        <ThreadType>value</ThreadType>
        <ThreadType>value</ThreadType>
      </AllowedThreadTypes>
      <DefaultThreadType>defaultthreadtype</DefaultThreadType>
      <Enabled>true</Enabled>
      <IndexPosts>true</IndexPosts>
      <ModeratePosts>true</ModeratePosts>
      <EnableModerationNotifications>true</EnableModerationNotifications>
      <EnablePostStatistics>true</EnablePostStatistics>
      <EnablePostPoints>true</EnablePostPoints>
      <PostsToModerate>76</PostsToModerate>
      <ThreadCount>6</ThreadCount>
      <ReplyCount>25</ReplyCount>
      <EmailAddress>emailaddress</EmailAddress>
      <EnableAnonymousPosting>true</EnableAnonymousPosting>
      <DefaultThreadStatus>defaultthreadstatus</DefaultThreadStatus>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <Application>
        <ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId>
        <ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Container>
          <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
          <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Application>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
    </Forum>
  </Forums>
</Response>

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Forums": [
    {
      "Name": "title",
      "Title": "title",
      "Url": "url",
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "\/Date(1325653200000-0500)\/",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 6,
        "Url": "url",
        "TotalMembers": 25,
        "HasGroups": true,
        "GroupCount": 8,
        "GroupType": 0,
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
          "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 4
      },
      "DateCreated": "\/Date(1335931200000-0400)\/",
      "LatestPostDate": "\/Date(1338782400000-0400)\/",
      "Description": "description",
      "AllowedThreadTypes": [
        {
          "Value": "value"
        },
        {
          "Value": "value"
        }
      ],
      "DefaultThreadType": "defaultthreadtype",
      "Enabled": true,
      "IndexPosts": true,
      "ModeratePosts": true,
      "EnableModerationNotifications": true,
      "EnablePostStatistics": true,
      "EnablePostPoints": true,
      "PostsToModerate": 7,
      "ThreadCount": 27,
      "ReplyCount": 32,
      "EmailAddress": "emailaddress",
      "EnableAnonymousPosting": true,
      "DefaultThreadStatus": "defaultthreadstatus",
      "SearchUniqueId": "searchuniqueid",
      "Application": {
        "ApplicationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
        "ApplicationTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
          "ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      },
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "Id": 52
    },
    {
      "Name": "title",
      "Title": "title",
      "Url": "url",
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "\/Date(1306555200000-0400)\/",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 19,
        "Url": "url",
        "TotalMembers": 112,
        "HasGroups": true,
        "GroupCount": 61,
        "GroupType": 0,
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
          "ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 18
      },
      "DateCreated": "\/Date(1323406800000-0500)\/",
      "LatestPostDate": "\/Date(1332993600000-0400)\/",
      "Description": "description",
      "AllowedThreadTypes": [
        {
          "Value": "value"
        },
        {
          "Value": "value"
        }
      ],
      "DefaultThreadType": "defaultthreadtype",
      "Enabled": true,
      "IndexPosts": true,
      "ModeratePosts": true,
      "EnableModerationNotifications": true,
      "EnablePostStatistics": true,
      "EnablePostPoints": true,
      "PostsToModerate": 76,
      "ThreadCount": 6,
      "ReplyCount": 25,
      "EmailAddress": "emailaddress",
      "EnableAnonymousPosting": true,
      "DefaultThreadStatus": "defaultthreadstatus",
      "SearchUniqueId": "searchuniqueid",
      "Application": {
        "ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      },
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "Id": 8
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}