REST-NewsCategory
This article provides details about the REST - NewsCategory API call that GFI HelpDesk uses, including its field types, arguments, and responses.
GET /News/Category
Retrieve the list of categories.
Response
<newscategory>
<id><![CDATA[1]]]]><![CDATA[></id>
<title><![CDATA[First]]]]><![CDATA[></title>
<newsitemcount><![CDATA[14]]]]><![CDATA[></newsitemcount>
<visibilitytype><![CDATA[public]]]]><![CDATA[></visibilitytype>
</newscategory>
<newscategory>
<id><![CDATA[2]]]]><![CDATA[></id>
<title><![CDATA[Second]]]]><![CDATA[></title>
<newsitemcount><![CDATA[14]]]]><![CDATA[></newsitemcount>
<visibilitytype><![CDATA[public]]]]><![CDATA[></visibilitytype>
</newscategory>
</newscategories>
GET /News/Category/$id$
Retrieve a category identified by $id$.
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the news category |
Response
<newscategory>
<id><![CDATA[1]]]]><![CDATA[></id>
<title><![CDATA[First]]]]><![CDATA[></title>
<newsitemcount><![CDATA[14]]]]><![CDATA[></newsitemcount>
<visibilitytype><![CDATA[public]]]]><![CDATA[></visibilitytype>
</newscategory>
</newscategories>
POST /News/Category
Create a new News category.
Arguments (POST variables)
| Name | Description |
|---|---|
| title | The category title |
| visibilitytype | The visibility type. Possible values are public or private |
Response
<newscategory>
<id><![CDATA[1]]]]><![CDATA[></id>
<title><![CDATA[adsf]]]]><![CDATA[></title>
<newsitemcount><![CDATA[14]]]]><![CDATA[></newsitemcount>
<visibilitytype><![CDATA[public]]]]><![CDATA[></visibilitytype>
</newscategory>
</newscategories>
PUT /News/Category/$id$
Update the News category identified by $id$.
Arguments
| Name | Description |
|---|---|
| title | The category title |
| visibilitytype | The visibility type. Possible values are public or private |
Response
<newscategory>
<id><![CDATA[1]]]]><![CDATA[></id>
<title><![CDATA[First]]]]><![CDATA[></title>
<newsitemcount><![CDATA[14]]]]><![CDATA[></newsitemcount>
<visibilitytype><![CDATA[public]]]]><![CDATA[></visibilitytype>
</newscategory>
</newscategories>
DELETE /News/Category/$id$
Delete a News category identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the category |