Category/List

List all categorys in a brands knowledgebase library.

Parameters

Parameter	Type	Required	Description
category_id	string	optional	Provide a 'category_id' to list a specific category.
category_type	string	optional	Priovide a category type to return only categories of that type; 'PARENT' and 'SUB' are acceptable values.
parent_category_id	string	optional	Provide a 'parent_category_id' to list sub categories of one or more parent categories.
name	string	optional	Provide a name to search for a category by name.
show_sub_categories	string	optional	Provide a 'Y' to show sub categories and their article count connected to a parent category. 'category_type' must be set to 'PARENT'.

GET https://api.recurringstack.com/{format}/Category/List

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('category_id' => "",'category_type' => "",'parent_category_id' => "",'name' => "",'show_sub_categories' => "");
try { $response = $rstack->request('Category/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
  <library>
    <category parent_category_id="b03e147a-d5e5-4431-aeeb-7020c8b05a6c" category_type="SUB" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" visibility="1" creation_date="2023-08-02 18:16:28" status="1">
      <name>Sub Category</name>
      <articles>0</articles>
    </category>
    <category category_type="PARENT" category_id="b03e147a-d5e5-4431-aeeb-7020c8b05a6c" visibility="1" creation_date="2023-08-02 17:57:56" status="1">
      <name>Test Parent Category</name>
      <articles>0</articles>
    </category>
  </library>
</recurringstack>

{
    "library": {
        "category": [
            {
                "@attributes": {
                    "parent_category_id": "b03e147a-d5e5-4431-aeeb-7020c8b05a6c",
                    "category_type": "SUB",
                    "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                    "visibility": "1",
                    "creation_date": "2023-08-02 18:16:28",
                    "status": "1"
                },
                "name": "Sub Category",
                "articles": "0"
            },
            {
                "@attributes": {
                    "category_type": "PARENT",
                    "category_id": "b03e147a-d5e5-4431-aeeb-7020c8b05a6c",
                    "visibility": "1",
                    "creation_date": "2023-08-02 17:57:56",
                    "status": "1"
                },
                "name": "Test Parent Category",
                "articles": "0"
            }
        ]
    }
}

API Simulator

Initiate a live call to the Category/List service using the API simulator.

category_id

category_type

parent_category_id

name

show_sub_categories

Your API credentials are missing, click "Set Credentials" to set them.

Category/Create

Create a primary or sub category in the knowledgebase library.

If creating a sub category a 'parent_category_id' must be supplied.

Parameters

Parameter	Type	Required	Description
name	string	required	The name of the knowledgebase library category.
category_type	string	required	The type of category to create ('PRIMARY' and 'SUB' are valid options).
parent_category_id	string	optional	The 'category_id' of a parent category if creating a sub category.
visibility	string	required	The visibility of the category. 1 - for visible; 2 - for hidden. Visibility does not affect the status of the category.

POST https://api.recurringstack.com/{format}/Category/Create

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('name' => "",'category_type' => "",'parent_category_id' => "",'visibility' => "");
try { $response = $rstack->request('Category/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481372">
  <library>
    <category category_type="PARENT" category_id="b03e147a-d5e5-4431-aeeb-7020c8b05a6c" visibility="1" creation_date="2023-08-02 17:57:56" status="1">
      <name>Test Parent Category</name>
    </category>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481372"
    },
    "library": {
        "category": {
            "@attributes": {
                "category_type": "PARENT",
                "category_id": "b03e147a-d5e5-4431-aeeb-7020c8b05a6c",
                "visibility": "1",
                "creation_date": "2023-08-02 17:57:56",
                "status": "1"
            },
            "name": "Test Parent Category"
        }
    }
}

API Simulator

Initiate a live call to the Category/Create service using the API simulator.

name

category_type

parent_category_id

visibility

Your API credentials are missing, click "Set Credentials" to set them.

Category/Update

Update a category.

Parameters

Parameter	Type	Required	Description
category_id	string	required	The 'category_id' of the category you wish to update.
name	string	required	The name of the knowledgebase library category.
category_type	string	required	The type of category to create ('PRIMARY' and 'SUB' are valid options).
parent_category_id	string	optional	The 'category_id' of a parent category if creating a sub category.
visibility	string	required	The visibility of the category. 1 - for visible; 2 - for hidden. Visibility does not affect the status of the category.

PATCH https://api.recurringstack.com/{format}/Category/Update

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('category_id' => "",'name' => "",'category_type' => "",'parent_category_id' => "",'visibility' => "");
try { $response = $rstack->request('Category/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481381">
  <library>
    <category parent_category_id="b03e147a-d5e5-4431-aeeb-7020c8b05a6c" category_type="SUB" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" visibility="1" creation_date="2023-08-02 18:16:28" status="1">
      <name>Sub Category</name>
    </category>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481381"
    },
    "library": {
        "category": {
            "@attributes": {
                "parent_category_id": "b03e147a-d5e5-4431-aeeb-7020c8b05a6c",
                "category_type": "SUB",
                "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                "visibility": "1",
                "creation_date": "2023-08-02 18:16:28",
                "status": "1"
            },
            "name": "Sub Category"
        }
    }
}

API Simulator

Initiate a live call to the Category/Update service using the API simulator.

category_id

name

category_type

parent_category_id

visibility

Your API credentials are missing, click "Set Credentials" to set them.

Category/Delete

Delete a category.

Categorys with sub categorys cannot be deleted until all sub categories are deleted first.

Parameters

Parameter	Type	Required	Description
category_id	string	required	The 'category_id' you wish to delete.

DELETE https://api.recurringstack.com/{format}/Category/Delete

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('category_id' => "");
try { $response = $rstack->request('Category/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481387">
  <library>
    <category category_type="SUB" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-02 18:16:28" deletion_date="2023-08-02 18:26:37" status="2"/>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481387"
    },
    "library": {
        "category": {
            "@attributes": {
                "category_type": "SUB",
                "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                "creation_date": "2023-08-02 18:16:28",
                "deletion_date": "2023-08-02 18:26:37",
                "status": "2"
            }
        }
    }
}

API Simulator

Initiate a live call to the Category/Delete service using the API simulator.

category_id

Your API credentials are missing, click "Set Credentials" to set them.

Category/Restore

Restore a category from deleted.

Parameters

Parameter	Type	Required	Description
category_id	string	required	The 'category_id' you wish to restore.

PATCH https://api.recurringstack.com/{format}/Category/Restore

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('category_id' => "");
try { $response = $rstack->request('Category/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481388">
  <library>
    <category category_type="SUB" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-02 18:16:28" deletion_date="2023-08-02 22:07:48" status="1"/>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481388"
    },
    "library": {
        "category": {
            "@attributes": {
                "category_type": "SUB",
                "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                "creation_date": "2023-08-02 18:16:28",
                "deletion_date": "2023-08-02 22:07:48",
                "status": "1"
            }
        }
    }
}

API Simulator

Initiate a live call to the Category/Restore service using the API simulator.

category_id

Your API credentials are missing, click "Set Credentials" to set them.

Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout	Remove the `.boxed-layout` and `.centered-layout` classes from the `body`.
Centered Layout	Add a class `.centered-layout` to the `body`.
Boxed Layout	Add a class `.boxed-layout` to the `body`.
Boxed Layout with background image	Add background image to the `body`. <body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'> .. .. </body> Or it could be in your own class. .bg-img { background-image: url("path_to_img/image.jpg"); } <body class="boxed-layout bg-img"> .. .. </body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header	Add a class `.hd--sticky` to the `#root`.
Expanded header	Add a class `.hd--expanded` to the `#root`.
Expanded header with overlapping content.	Add a class `.overlapping` to the `#content > .content__header`.
Disable rounded header.	Add a class `.rounded-0` to the `#content > .content__header`.

Navigation

Max navigation by default	Add a class `.mn--max` to the `#root`.
Min navigation by default	Add a class `.mn--min` to the `#root`.
OffCanvas navigation with PUSH mode by default	Add a class `.mn--push` to the `#root`.
OffCanvas navigation with SLIDE mode by default	Add a class `.mn--slide` to the `#root`.
OffCanvas navigation with REVEAL mode by default	Add a class `.mn--slide` to the `#root`.
Sticky navigation	Add a class `.mn--sticky` to the `#root`.
Create a ToggleButton for navigation	Add a class `.nav-toggler` to the button. Example :

Sidebar

Disable sidebar backdrop	Add a class `.sb--bd-0` to the `#root`.
Static position	Add a class `.sb--static` to the `#root`.
Stuck sidebar as the default mode	Add a class `.sb--stuck` to the `#root`.
Unite sidebar as the default mode	Add a class `.sb--unite` to the `#root`.
Pinned sidebar as the default mode	Add a class `.sb--pinned` to the `#root`.
Toggle visibility	Toggle the class `.sb--show` in the `#root`.
Create a ToggleButton for Sidebar	Add a class `.sidebar-toggler` to the button. Example :

Animations

Add the following class to the body to change the animation transition.

Transition function name	Class name
In Quart	`.in-quart`
Out Quart	`.out-quart`
In Back	`.in-back`
Out Back	`.out-back`
In Out Back	`.in-out-back`
easeInOutBack	`.easeInOutBack`
steps	`.steps`
jumping	`.jumping`
rubber	`.rubber`