...
...
The following operations allow you to work with categories. Click an operation name to see details on how to use it.
For a sample proxy service that illustrates how to work with categories, see Sample configuration.
This section provides further details on the operations related to categories.
Anchor |
---|
| getCategoryDetails |
---|
| getCategoryDetails |
---|
|
Returning category detailsThe getCategoryDetails
operation returns category details.
Code Block |
---|
language | xml |
---|
title | getCategoryDetails |
---|
|
<disqus.getCategoryDetails>
<categoryId>{$ctx:categoryId}</categoryId>
</disqus.getCategoryDetails> |
categoryId:
The ID of the category to retrieve.
Sample requestFollowing is a sample REST/JSON request that can be handled by the getCategoryDetails
operation.
Code Block |
---|
language | xml |
---|
title | Sample Request for getCategoryDetails |
---|
|
{
"categoryId": "3329663",
"apiUrl": "https://disqus.com",
"apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu"
} |
https://disqus.com/api/docs/categories/details/
Anchor |
---|
| listCategories |
---|
| listCategories |
---|
|
Returning a list of categoriesThe listCategories operation returns a list of categories within a forum.
Code Block |
---|
language | xml |
---|
title | listCategories |
---|
|
<disqus.listCategories>
<forumId>{$ctx:forumId}</forumId>
<limit>{$ctx:limit}</limit>
<order>{$ctx:order}</order>
<cursor>{$ctx:cursor}</cursor>
<sinceId>{$ctx:sinceId}</sinceId>
</disqus.listCategories> |
forumId:
The ID of the Disqus forum to retrieve.limit:
The maximum number of posts to return.order:
The order of entries returned: "ASC" or "DESC" (default).cursor:
The pagination parameter.sinceId:
Returns categories created since the given date ID.
Following is a sample REST/JSON request that can be handled by the listCategories operation.
Code Block |
---|
language | xml |
---|
title | Sample Request for listCategories |
---|
|
{
"limit": "10",
"sinceId": "3360607",
"cursor": "",
"order": "desc",
"forumId": "java-ee-forum,palaforum",
"apiUrl": "https://disqus.com",
"apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu"
} |
https://disqus.com/api/docs/categories/list/
Anchor |
---|
| sampleconfiguration |
---|
| sampleconfiguration |
---|
|
Sample configurationFollowing is a sample proxy service that illustrates how to connect to Disqus with the init
operation and use the getCategoryDetails operation. The sample request for this proxy can be found in the getCategoryDetails sample request. You can use this sample as a template for using other operations in this category.
...