Article/List

List one or more library articles using the specified search criteria.

Listing or searching articles using 'tags' will increase response time.

Each time an article is retreived utilizing the 'article_id' the "view_count" for that article is increased by one. The 'view_count' is only returned utilizing the 'List' service.

Parameters

Parameter	Type	Required	Description
article_id	string	optional	The 'article_id' of a specific article to list.
category_id	string	optional	Provide a 'category_id' to list articles associated with a specific category.
tags	string	optional	Provide a tag or a part of one to search for an article by it's tags.

GET https://api.recurringstack.com/{format}/Article/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('article_id' => "",'category_id' => "",'tags' => "");
try { $response = $rstack->request('Article/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack>
  <library>
    <article article_id="63e4f00d-2a5c-49b6-8efb-2c1c0f852acf" visibility="2" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-04 16:29:55" deletion_date="0000-00-00 00:00:00" status="1">
      <title>Second example article.</title>
      <summary><![CDATA[This is the summary of this second test article.]]></summary>
      <tags>second, test, article, here</tags>
      <category friendly="Sub Category/Test Parent Category">Sub Category</category>
    </article>
    <article article_id="8e1b1860-08f7-4d7c-ab81-58d97b221de6" visibility="1" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-04 15:42:47" deletion_date="0000-00-00 00:00:00" status="1">
      <title>This is the article title</title>
      <summary><![CDATA[Hello summary of the article.]]></summary>
      <tags>next, article, going, long</tags>
      <category friendly="Sub Category/Test Parent Category">Sub Category</category>
    </article>
  </library>
</recurringstack>

{
    "library": {
        "article": [
            {
                "@attributes": {
                    "article_id": "63e4f00d-2a5c-49b6-8efb-2c1c0f852acf",
                    "visibility": "2",
                    "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                    "creation_date": "2023-08-04 16:29:55",
                    "deletion_date": "0000-00-00 00:00:00",
                    "status": "1"
                },
                "title": "Second example article.",
                "summary": {},
                "tags": "second, test, article, here",
                "category": "Sub Category"
            },
            {
                "@attributes": {
                    "article_id": "8e1b1860-08f7-4d7c-ab81-58d97b221de6",
                    "visibility": "1",
                    "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                    "creation_date": "2023-08-04 15:42:47",
                    "deletion_date": "0000-00-00 00:00:00",
                    "status": "1"
                },
                "title": "This is the article title",
                "summary": {},
                "tags": "next, article, going, long",
                "category": "Sub Category"
            }
        ]
    }
}

API Simulator

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

article_id

category_id

Article/Create

Create a new article in the library under a category or sub category.

Article 'visibility' does not affect the articles ability to be listed using the 'list' API.

Parameters

Parameter	Type	Required	Description
category_id	string	required	The 'category_id' of the category where you wish to place the article.
title	string	required	The title or subject of the article.
summary	string	optional	A summary of the article conetents.
contents	string	required	The contents of the article; either plan text or HTML.
tags	string	required	One or more tags or keywords relating to the article contents. Tags can be comma seperated or any common tag format.
visibility	string	required	The visibility of the article. 1 - for visible; 2 - for hidden. Visibility does not affect the status of the article.

POST https://api.recurringstack.com/{format}/Article/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('category_id' => "",'title' => "",'summary' => "",'contents' => "",'tags' => "",'visibility' => "");
try { $response = $rstack->request('Article/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481390">
  <library>
    <article article_id="98a59746-2947-48b7-99a5-ee217b997801" visibility="1" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-03 23:26:20" status="1">
      <title>How do I setup my product interface?</title>
      <summary><![CDATA[This is a summary of how you setup your product interface.]]></summary>
      <contents><![CDATA[This is the article content that gives you information on how to setup your product interface. You may use the RStore to host some images for the article.]]></contents>
      <tags>search engine, tags, search, help</tags>
    </article>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481390"
    },
    "library": {
        "article": {
            "@attributes": {
                "article_id": "98a59746-2947-48b7-99a5-ee217b997801",
                "visibility": "1",
                "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                "creation_date": "2023-08-03 23:26:20",
                "status": "1"
            },
            "title": "How do I setup my product interface?",
            "summary": {},
            "contents": {},
            "tags": "search engine, tags, search, help"
        }
    }
}

API Simulator

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

category_id

title

summary

contents

Article/Update

Update an existing library article.

Parameters

Parameter	Type	Required	Description
article_id	string	required	The 'article_id' of the artcile you wish to update.
category_id	string	required	The 'category_id' of the category where you wish to place the article.
title	string	required	The title or subject of the article.
summary	string	optional	A summary of the article conetents.
contents	string	required	The contents of the article; either plan text or HTML.
tags	string	required	One or more tags or keywords relating to the article contents. Tags can be comma seperated or any common tag format.
visibility	string	required	The visibility of the article. 1 - for visible; 2 - for hidden. Visibility does not affect the status of the article.

PATCH https://api.recurringstack.com/{format}/Article/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('article_id' => "",'category_id' => "",'title' => "",'summary' => "",'contents' => "",'tags' => "",'visibility' => "");
try { $response = $rstack->request('Article/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481399">
  <library>
    <article article_id="63e4f00d-2a5c-49b6-8efb-2c1c0f852acf" visibility="1" category_id="0264854b-8e05-49ed-b4c4-b9c67ba19d3f" creation_date="2023-08-04 16:29:55" last_update="2023-08-10 13:12:00" status="1">
      <title>We updated our test article with this title.</title>
      <summary><![CDATA[The test article that we made before with the create service has been updated.]]></summary>
      <contents><![CDATA[There would normally be more information here about the update.]]></contents>
      <tags>article, updated, last, update date, changed</tags>
    </article>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481399"
    },
    "library": {
        "article": {
            "@attributes": {
                "article_id": "63e4f00d-2a5c-49b6-8efb-2c1c0f852acf",
                "visibility": "1",
                "category_id": "0264854b-8e05-49ed-b4c4-b9c67ba19d3f",
                "creation_date": "2023-08-04 16:29:55",
                "last_update": "2023-08-10 13:12:00",
                "status": "1"
            },
            "title": "We updated our test article with this title.",
            "summary": {},
            "contents": {},
            "tags": "article, updated, last, update date, changed"
        }
    }
}

API Simulator

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

article_id

category_id

title

summary

contents

Article/Delete

Delete a library artcile.

Like categories, articles can be restored from deletion within 90 days. Although articles can be restored, we highly recommend not using the delete service to hide articles and instead use the 'visibility' flag.

Parameters

Parameter	Type	Required	Description
article_id	string	required	The 'article_id' of the article you wish to delete.

DELETE https://api.recurringstack.com/{format}/Article/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('article_id' => "");
try { $response = $rstack->request('Article/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481402">
  <library>
    <article article_id="63e4f00d-2a5c-49b6-8efb-2c1c0f852acf" creation_date="2023-08-04 16:29:55" deletion_date="2023-08-04 18:12:39" status="2"/>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481402"
    },
    "library": {
        "article": {
            "@attributes": {
                "article_id": "63e4f00d-2a5c-49b6-8efb-2c1c0f852acf",
                "creation_date": "2023-08-04 16:29:55",
                "deletion_date": "2023-08-04 18:12:39",
                "status": "2"
            }
        }
    }
}

API Simulator

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

article_id

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

Article/Restore

Restore a library article that's been previously deleted.

Parameters

Parameter	Type	Required	Description
article_id	string	required	The 'article_id' of the article you wish to restore.

PATCH https://api.recurringstack.com/{format}/Article/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('article_id' => "");
try { $response = $rstack->request('Article/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="481404">
  <library>
    <article article_id="63e4f00d-2a5c-49b6-8efb-2c1c0f852acf" creation_date="2023-08-04 16:29:55" status="1"/>
  </library>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "481404"
    },
    "library": {
        "article": {
            "@attributes": {
                "article_id": "63e4f00d-2a5c-49b6-8efb-2c1c0f852acf",
                "creation_date": "2023-08-04 16:29:55",
                "status": "1"
            }
        }
    }
}

API Simulator

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

article_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`