Articles

Describes the various implementations for retrieving Adviser Portals Articles over the API. Requests available are 'articlecategories', 'articles' and 'article'. Articles are maintained and updated by Adviser Portals, and controlled by Network/Service Provider 'approval' and 'expiry date'.

Article Categories

Article Categories are the categories under which articles are available via the API.

Filter Key: None

Request

https://adviserportals.co.uk/api/1.0/articlecategories/apikey/responseformat

XML Response

<?xml version="1.0" encoding="utf-8"?>
<articleCategories>
    <header/>
    <data>
        <articleCategory>
            <articleCategoryID></articleCategoryID>
            <articleCategoryName></articleCategoryName>
            <articleCategoryDescription></articleCategoryDescription>
            <articleCategoryThumbnail></articleCategoryThumbnail>
        </articleCategory>    
    </data>
</articleCategories>

PHP

$api->getArticleCategories();

Articles

Articles are compliance checked and approved by various Networks and Service Providers.

Filter Key: articleid,articlecategoryid,articlecategoryname (optional)

Request

https://adviserportals.co.uk/api/1.0/articles/apikey/responseformat/articleid/filtervalue
https://adviserportals.co.uk/api/1.0/articles/apikey/responseformat/articlecategoryid/filtervalue
https://adviserportals.co.uk/api/1.0/articles/apikey/responseformat/articlecategoryname/filtervalue

XML Response

<?xml version="1.0" encoding="utf-8"?>
<articles>
    <header/>
    <data>
        <article>
            <articleID></articleID>
            <articleTitle></articleTitle>
            <articleIntro></articleIntro>
            <articleThumbnail></articleThumbnail>
            <articleCategoryID></articleCategoryID>
            <articleCategoryName></articleCategoryName>
        </article>
    </data>
</articles>

PHP

$api->getArticles($articleid = null);
$api->getArticlesByCategoryID($articlecategoryid = null);
$api->getArticlesByCategoryName($articlecategoryname = null);

Article

Retrieve a single article

Filter Key: articleid (required)

Request

https://adviserportals.co.uk/api/1.0/articles/apikey/responseformat/articleid/filtervalue

XML Response

<?xml version="1.0" encoding="utf-8"?>
<articles>
    <header/>
    <data>
        <article>
            <articleID></articleID>
            <articleTitle></articleTitle>
            <articleNarrative></articleNarrative>
        </article>
    </data>
</articles>

PHP

$api->getArticle($articleid);