# get_forum
# Function
| Function Name | Description | Level |
|---|---|---|
| get_forum | Return full forum in a nested tree structure. In API Level 3 no parameter required for this function and the sub-forum description. For Level 4, forum description is omitted unless "return_description" is set to true | 3,4 |
Input Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| return_description | Boolean | request to return sub-forum description. | 4 | |
| forum_id | String | if this parmeter is presented, return only the immediate child of this forum. | 4 |
Output Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| Array of Hash table | yes | 3 | ||
| forum_id | String | yes | 3 | |
| forum_name | byte[] | 3 | ||
| description | byte[] | Description of the forum. If required_description is set to true. | 4 | |
| parent_id | String | yes | parent's forum ID of this forum, returns -1 if this forum is the root forum | 3 |
| logo_url | String | returns the forum logo art-work URL (absolute URL). If any. | 3 | |
| new_post | Boolean | returns true if this forum contains unread topic | 3 | |
| is_protected | Boolean | returns true if this forum is password protected. The app side will call "login_forum" to get authorization before attempting to call get_topic the this forum. | 3 | |
| is_subscribed | Boolean | returns true if the user has previously subscribed to this forum | 3 | |
| can_subscribe | Boolean | returns false if the subscription feature is turned off | 3 | |
| url | String | if it contains a url, it means this forum is just a link to other webpage | 3 | |
| sub_only | Boolean | yes | (true/false) identify whether this forum is only a placeholder ("Category" in vBulletin term) for sub-forums (sub_only = true), or can contains both topics and forums (sub_only = false) | 3 |
| child | Array of Hash table | if this forum is not a "leaf" forum, returns a list of child forum in an array of hash. This "child" key should return an array of hash. This entire structure can be nested. Client assume this is a leaf forum if this key is missing from the response | 3,4 |
# Example
Request:
<?xml version="1.0"?>
<methodCall>
<methodName>get_forum</methodName>
<params>
</params>
</methodCall>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>c1</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>57u85ZCI</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>-1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
<member>
<name>child</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>1</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5p2C6LCI</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64>5LuA5LmI6YO95Y+v5Lul6IGK</base64></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>8</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5Yqo5ryr</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64>5Yqo55S7L+a8q+eUuw==</base64></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>10</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5Yib5L2c</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>2</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5ri45oiP57u85ZCI</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
<member>
<name>child</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>9</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>NDY2Q3JhZnQ=</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>2</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64>5pys56uZ55qETWluZWNyYWZ05pyN5Yqh5Zmo77yM5aSn5omL5Lus6K+35L6/44CC</base64></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>c4</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>54mI5Yqh</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>-1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
<member>
<name>child</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>6</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5YWs5ZGK</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c4</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>7</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>54mI5Yqh</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c4</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>c2</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>6ZuF5bqn</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>-1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
<member>
<name>child</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>4</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>T0fpm4Xluqc=</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c2</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>c3</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>5Y+L5oOF6ZO+5o6l</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>-1</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/off.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string></string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
<member>
<name>child</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>forum_id</name>
<value><string>5</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>a2FtaWh1Yg==</base64></value>
</member>
<member>
<name>parent_id</name>
<value><string>c3</string></value>
</member>
<member>
<name>logo_url</name>
<value><string>https://www.tdgsgl.top/Themes/LlamaTheme/images/redirect.png</string></value>
</member>
<member>
<name>new_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>url</name>
<value><string>https://kamihub.com/</string></value>
</member>
<member>
<name>sub_only</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_protected</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_post</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>description</name>
<value><base64></base64></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>