Overview

This article provides details about the REST - NewsCategory API call that Kayako Classic uses, including its field types, arguments, and responses. 

• GET /News/Category
  • Response
• GET /News/Category/$id$
  • Arguments
  • Response
• POST /News/Category
  • Arguments (POST variables)
  • Response
• PUT /News/Category/$id$
  • Arguments
  • Response
• DELETE /News/Category/$id$
  • Arguments

 

Information

GET /News/Category

Retrieve the list of categories.

Response

<newscategories>
   <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$.

Arguments

Name	Description
$id$	The unique numeric identifier of the news category.

Response

<newscategories>
   <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)

Red = required, Blue = Either of the value

Name	Description
title	The category title
visibilitytype	The visibility type. public or private

Response

<newscategories>
   <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

Red = required

Name	Description
title	The category title
visibilitytype	The visibility type. public or private

Response

<newscategories>
   <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

Red = required

Name	Description
$id$	The unique numeric identifier of the category