# get_thread
# Function
| Function Name | Description | Level |
|---|---|---|
| get_thread | Returns a list of posts under the same thread, given a topic_id | 3,4 |
Input Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| topic_id | String | yes | Topic ID of the thread. | 3 |
| start_num | Int | yes | For pagination. If start_num = 0 & last_num = 9, it returns first 10 posts from the topic. If both are not presented, return first 20 posts. if start_num = 0 and last_num = 0, return the first post only, and so on (e.g. 1,1; 2,2). If start_num smaller than last_num returns null. If last_num - start_num > 50, returns only first 50 posts starting from start_num | 3 |
| last_num | Int | yes | 3 | |
| return_html | Boolean | 4 |
Output Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| total_post_num | Int | yes | total number of posts in this topic | 3 |
| forum_id | String | yes | 3 | |
| forum_name | byte[] | yes | 3 | |
| topic_id | String | yes | 3 | |
| topic_title | byte[] | yes | 3 | |
| topic_author_id | String | Topic author ID | ||
| topic_author_name | byte[] | Topic author display name | ||
| topic_author_avatar | String | Topic author avatar | ||
| view_number | Int | |||
| prefix | byte[] | 4 | ||
| is_subscribed | Boolean | return true if this thread has been subscribed by this user. | 3 | |
| can_subscribe | Boolean | returns false if the subscription feature is turned off | 3 | |
| is_poll | Boolean | return ture if this topic contains poll | ||
| is_closed | Boolean | return true if this thread has been closed. If this thread is closed, it should not allow reply or edit unless can_reply (thread) or can_edit (post) are set to "true" explicitly | 3 | |
| can_report | Boolean | return true if if user can report post in this thread | ||
| can_reply | Boolean | return false if user cannot reply to this thread. | 3 | |
| breadcrumb | Array of Hash table | Forum nav to current thread, order from top forum to it's parent forum | ||
| forum_id | String | |||
| forum_name | byte[] | |||
| sub_only | Boolean | |||
| posts | Array of Hash table | yes | an array contains a list of posts in a thread. | 3 |
| post_id | String | yes | 3 | |
| post_title | byte[] | yes | Remove all BBCode in title | 3 |
| post_content | byte[] | yes | Characters display rules (follow the sequence): 1) Remove all BBCode except [url], [img], [quote], [spoiler] 2) Remove all non-displayable characters (e.g. \n, \t, white-space, etc) at the beginning AND the end of the content (Trimming) 3) when 'return_html' was set as true, it will also return html tag <b>,<i>,<u>,<br /> | 3 |
| post_author_id | String | yes | 4 | |
| post_author_name | byte[] | yes | 3 | |
| is_online | Boolean | return true if this user is currently online | 3 | |
| can_edit | Boolean | eturn true if user can edit this post. | 3 | |
| icon_url | String | Return topic author avatar URL | 3 | |
| timestamp | String | yes | Timestamp of topic last reply | |
| post_time | Date | yes | dateTime.iso8601 format. If this topic has no reply, use the topic creation time. | 3 |
| allow_smilies | Boolean | This value (if "false") is to instruct the app do not display smilies and instead display it in text format. This is to address certain forum system allows forum admin to disable smilies across the board. If this flag is missing, assume "true" | 4 | |
| editor_id | String | |||
| editor_name | byte[] | Display name of the editor | ||
| edit_time | String | Timestamp of the edit time | ||
| edit_reason | byte[] | |||
| attachments | Array of Hash table | Returns a list of attachments user has uploaded within this post, in array of hash format. | 3 | |
| content_type | String | yes | return "image", "pdf" or "other" | 3 |
| thumbnail_url | String | if content type = "image", use absolute path (optional: if not presented, use "url" to load thumbnail instead) | 3 | |
| url | String | URL of the attachment source. | 3 | |
| filename | byte[] | |||
| filesize | Int | |||
| thanks_info | Array of Hash table | Return post thanks user list infor only when thank_post is supported. | ||
| userid | String | Id of the user who has thanked this post | ||
| username | byte[] | Name of the user who has thanked this post | ||
| likes_info | Array of Hash table | Return post likes user list infor only when like_post/unlike_post are supported. | ||
| userid | String | Id of the user who has liked this post | ||
| username | byte[] | Name of the user who has liked this post | ||
| client_type | String | the post from which client. return: "web", "mobile", "app", or "" | 4 |
# Example
Request:
<?xml version="1.0"?>
<methodCall>
<methodName>get_thread</methodName>
<params>
<param><value><string>93</string></value></param>
</params>
</methodCall>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>total_post_num</name>
<value><int>5</int></value>
</member>
<member>
<name>forum_id</name>
<value><string>7</string></value>
</member>
<member>
<name>forum_name</name>
<value><base64>54mI5Yqh</base64></value>
</member>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>topic_title</name>
<value><base64>5ZCs6K+d77yM57uZ5oiR5Y+R5Y+R77yB</base64></value>
</member>
<member>
<name>topic_author_id</name>
<value><string>2</string></value>
</member>
<member>
<name>topic_author_name</name>
<value><base64>bWlzc2luZzcxMzY=</base64></value>
</member>
<member>
<name>topic_author_avatar</name>
<value><string></string></value>
</member>
<member>
<name>topic_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>view_number</name>
<value><int>135</int></value>
</member>
<member>
<name>can_subscribe</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>is_subscribed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_poll</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_stick</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>is_sticky</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_reply</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_upload</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_close</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>is_closed</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>position</name>
<value><int>1</int></value>
</member>
<member>
<name>can_move</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_report</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_merge</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_rename</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>breadcrumb</name>
<value>
<array>
<data>
<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>sub_only</name>
<value><boolean>1</boolean></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>sub_only</name>
<value><boolean>0</boolean></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>posts</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>post_id</name>
<value><string>862</string></value>
</member>
<member>
<name>post_title</name>
<value><base64>5ZCs6K+d77yM57uZ5oiR5Y+R5Y+R77yB</base64></value>
</member>
<member>
<name>post_content</name>
<value><base64>5Y+R6YCB6Ieq5Z+65LqOIFBvc3RtYW4gKyDmiYvlhplYTUwtUlBD6K+35rGC55qEIFRhcGF0YWxrIEFQSQ==</base64></value>
</member>
<member>
<name>post_author_id</name>
<value><string>2</string></value>
</member>
<member>
<name>post_author_name</name>
<value><base64>bWlzc2luZzcxMzY=</base64></value>
</member>
<member>
<name>post_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>icon_url</name>
<value><string>https://www.tdgsgl.top/index.php?action=dlattach;attach=138;type=avatar</string></value>
</member>
<member>
<name>post_time</name>
<value><dateTime.iso8601>20200429T11:33:12+00:00</dateTime.iso8601></value>
</member>
<member>
<name>timestamp</name>
<value><string>1588131192</string></value>
</member>
<member>
<name>attachments</name>
<value><array><data></data></array></value>
</member>
<member>
<name>is_online</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_edit</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>allow_smilies</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>post_id</name>
<value><string>863</string></value>
</member>
<member>
<name>post_title</name>
<value><base64>UmU6IOWQrOivne+8jOe7meaIkeWPkeWPke+8gQ==</base64></value>
</member>
<member>
<name>post_content</name>
<value><base64>5Y+R6YCB6Ieq5Z+65LqOIFBvc3RtYW4gKyDmiYvlhplYTUwtUlBD6K+35rGC55qEIFRhcGF0YWxrIEFQSQ==</base64></value>
</member>
<member>
<name>post_author_id</name>
<value><string>2</string></value>
</member>
<member>
<name>post_author_name</name>
<value><base64>bWlzc2luZzcxMzY=</base64></value>
</member>
<member>
<name>post_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>icon_url</name>
<value><string>https://www.tdgsgl.top/index.php?action=dlattach;attach=138;type=avatar</string></value>
</member>
<member>
<name>post_time</name>
<value><dateTime.iso8601>20200429T11:40:17+00:00</dateTime.iso8601></value>
</member>
<member>
<name>timestamp</name>
<value><string>1588131617</string></value>
</member>
<member>
<name>attachments</name>
<value><array><data></data></array></value>
</member>
<member>
<name>is_online</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_edit</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>allow_smilies</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>post_id</name>
<value><string>864</string></value>
</member>
<member>
<name>post_title</name>
<value><base64>UmU6IOWQrOivne+8jOe7meaIkeWPkeWPke+8gQ==</base64></value>
</member>
<member>
<name>post_content</name>
<value><base64>wqA6Z2xuMDAyOg==</base64></value>
</member>
<member>
<name>post_author_id</name>
<value><string>20</string></value>
</member>
<member>
<name>post_author_name</name>
<value><base64>6Zmk5aSV5aSc</base64></value>
</member>
<member>
<name>post_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>icon_url</name>
<value><string>https://www.tdgsgl.top/index.php?action=dlattach;attach=125;type=avatar</string></value>
</member>
<member>
<name>post_time</name>
<value><dateTime.iso8601>20200429T11:41:41+00:00</dateTime.iso8601></value>
</member>
<member>
<name>timestamp</name>
<value><string>1588131701</string></value>
</member>
<member>
<name>attachments</name>
<value><array><data></data></array></value>
</member>
<member>
<name>is_online</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_edit</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>allow_smilies</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>post_id</name>
<value><string>865</string></value>
</member>
<member>
<name>post_title</name>
<value><base64>UmU6IOWQrOivne+8jOe7meaIkeWPkeWPke+8gQ==</base64></value>
</member>
<member>
<name>post_content</name>
<value><base64>5L+u5pS55qCH6aKY5rKh5ZWl55So77yfCuWQrOivne+8jOe7meaIkeWbnuWbnu+8gQoKCi0tIOWPkemAgeiHquWfuuS6jiBQb3N0bWFuICsg5omL5YaZWE1MLVJQQ+ivt+axgueahCBUYXBhdGFsayBBUEk=</base64></value>
</member>
<member>
<name>post_author_id</name>
<value><string>2</string></value>
</member>
<member>
<name>post_author_name</name>
<value><base64>bWlzc2luZzcxMzY=</base64></value>
</member>
<member>
<name>post_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>icon_url</name>
<value><string>https://www.tdgsgl.top/index.php?action=dlattach;attach=138;type=avatar</string></value>
</member>
<member>
<name>post_time</name>
<value><dateTime.iso8601>20200429T11:42:37+00:00</dateTime.iso8601></value>
</member>
<member>
<name>timestamp</name>
<value><string>1588131757</string></value>
</member>
<member>
<name>attachments</name>
<value><array><data></data></array></value>
</member>
<member>
<name>is_online</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_edit</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>allow_smilies</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>topic_id</name>
<value><string>89</string></value>
</member>
<member>
<name>post_id</name>
<value><string>866</string></value>
</member>
<member>
<name>post_title</name>
<value><base64>UmU6IOWQrOivne+8jOe7meaIkeWPkeWPke+8gQ==</base64></value>
</member>
<member>
<name>post_content</name>
<value><base64>W3F1b3RlIG5hbWU9Im1pc3Npbmc3MTM2IiBwb3N0PTg2NSB0aW1lc3RhbXA9MTU4ODEzMTc1N10K5L+u5pS55qCH6aKY5rKh5ZWl55So77yfCuWQrOivne+8jOe7meaIkeWbnuWbnu+8gQoKCi0tIOWPkemAgeiHquWfuuS6jiBQb3N0bWFuICsg5omL5YaZWE1MLVJQQ+ivt+axgueahCBUYXBhdGFsayBBUEkKWy9xdW90ZV0K5oyH5LuA5LmI77yf</base64></value>
</member>
<member>
<name>post_author_id</name>
<value><string>20</string></value>
</member>
<member>
<name>post_author_name</name>
<value><base64>6Zmk5aSV5aSc</base64></value>
</member>
<member>
<name>post_author_user_type</name>
<value><string>normal</string></value>
</member>
<member>
<name>icon_url</name>
<value><string>https://www.tdgsgl.top/index.php?action=dlattach;attach=125;type=avatar</string></value>
</member>
<member>
<name>post_time</name>
<value><dateTime.iso8601>20200429T11:45:31+00:00</dateTime.iso8601></value>
</member>
<member>
<name>timestamp</name>
<value><string>1588131931</string></value>
</member>
<member>
<name>attachments</name>
<value><array><data></data></array></value>
</member>
<member>
<name>is_online</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_edit</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>can_delete</name>
<value><boolean>0</boolean></value>
</member>
<member>
<name>allow_smilies</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>