API Definition

Saving Stories

Story Folders are containers to save selected stories. A news search, or saved search, returns a set of stories matching the search query. At times, only selected stories are desired for presentation in your application or your website, use Story Folders to collect these stories of interest. Add selected stories to the folder using the storyfolder/addstory API. Alternatively, link a saved search to the folder, then using the autofill feature and story status options, decide which stories remain in the folder and which are excluded.

To access the contents of the Story Folder use the storyfolder/liststories API. If the folder contents are needed as an RSS feed, use the rss/get API. Or if using Web News Widgets, link the widget data source to the folder ID.

Creating a Story Folder
Managing Story Folders
Adding stories to a folder
Managing stories in a folder
Linking a Saved Search to a folder
Accessing Story Folder contents

Creating a Story Folder
This example shows how to create a story folder and adjust the folder settings.
  1. Create the folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/create?session=935DA0B364E9E130F0EC3827FC3CCC9C&name=My+Stories

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791" name="My Stories"/>
    </opens-api>
  2. Add a description for the folder.
    Adding a description is helpful to learn more about the content held in the folder and deciding which folder to use for various activities.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&description=Stories+for+my+homepage

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  3. Set an expiry date for folder contents.
    By default, the story folder contents expire and are removed from the folder after 90 days. In the example below, change the expiry value to remove the content from the folder after 30 days.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&expiry=30

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  4. Setting story status preferences.

    When a story is added to a folder, it is assigned a status and this status can be used for managing content life-cycle. Each story is typically set to one of three states: ACTIVE, PENDING, STORED. Stories marked as PENDING can be considered as on-hold, awaiting review by an editor, before being approved and transitioned to the ACTIVE state. ACTIVE stories may be considered ready to be displayed to readers. When ACTIVE stories are transitioned to the STORED status, these stories are considered as archived.

    The transition from one status to another can be processed by submitting requests to the storyfolder/updatestory API with optional parameters story ID and status, or it can be managed by setting the story folder preferences for pendingDelay and activeDelay. The pendingDelay default is zero, which means a story added to the folder is not marked PENDING, i.e. it is immediately marked as ACTIVE. The activeDelay default is -1, which means a story remains ACTIVE until a request is made to change the story to the STORED status.

    In this example, the story folder contents are destined for a homepage and before the headline appears on the site, you want the stories to be marked PENDING first. So, pendingDelay will be -1. Furthermore, ACTIVE content will be marked as STORED after 7 days. So, activeDelay will be 7.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&pendingDelay=-1&activeDelay=7

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>

Managing Story Folders
  1. List story folders.
    This example shows how to obtain a list of all the story folders created or shared with the OPENS API user.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

    Response
    <opens-api>
      <status>OK</status>
      <storyfolders count="3">
        <storyfolder id="17786" count="0" sharing="" name="Industry News" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="RANK"/>
        <storyfolder id="17791" count="0" sharing="" name="My Stories" description="Stories for my homepage" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="RANK"/>
        <storyfolder id="17785" count="0" sharing="" name="My Stories manual fill" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="DATEADDED"/>
      </storyfolders>
    </opens-api>
  2. View details of a story folder.
    In this example, view the settings for the My Stories folder created in previous steps.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/info?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="" autofillSearchName="" autofillMode="manual" autofillDepth="0" autofillCount="0" count="0">
        <sharing value=""/>
        <pending-delay value="-1"/>
        <active-delay value="7"/>
        <autofillActiveDelay value=""/>
        <expiry value="30"/>
        <writeability value=""/>
        <manageability value="NONE"/>
        <description value="Stories for my homepage"/>
        <sort value="RANK"/>
      </storyfolder>
    </opens-api>
  3. Rename a folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17785&name=My+Stories+manual+fill+TEST

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  4. Delete a story folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/delete?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17786

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>

Adding stories to a folder
This example shows how to add a story to the folder after running a news search or a saved search to identify a story of interest.
  1. Choose a folder where stories are to be added.
    Use the storyfolder/list API to review the available folders and choose one where stories are to be added. In this example, note the folder ID is 17791.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

    Response
    <opens-api>
      <status>OK</status>
      <storyfolders count="2">
        <storyfolder id="17791" count="0" sharing="" name="My Stories" description="Stories for my homepage" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="RANK"/>
        <storyfolder id="17785" count="0" sharing="" name="My Stories manual fill" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="DATEADDED"/>
      </storyfolders>
    </opens-api>
  2. Run a search to find stories.

    Using news/search, either submit a saved search request with the optional parameter savedsearch or submit a new query, to retrieve search results and choose stories to add to a folder. In the example below, a new search query will be submitted with the ACME subject for Artificial Intelligence. From the search results list, identify a couple of stories of interest.


    Request
    https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query=[SUBC:is/appsci.artintel]

    Response
    <searchResults searchKey="112030_20171120T094258834">
      <search startDate="20171113T000000-0500" endDate="20171120T094358-0500" resultsPerPage="10" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="0" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">...</search>
      <highlightTerms str="subCodeHighlight=is%2Fappsci.artintel">...</highlightTerms>
      <pageInfo>...</pageInfo>
      <results status="true">
        <result score="0.09002196">...</result>
        <result score="0.18015312">...</result>
        <result score="0.20934388">
          <id>1zliV5EWsVsjtRgzXSz_U1XPsNDg8fJnvAGmuufWk1UvxGkUbpS9RRlXzHu1JBwt</id>
          <storyURL>https://secure.newsedge.com/opensapi/20/news/read?key=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0</storyURL>
          <type code="News"/>
          <publication-date>20171113T180000-0500</publication-date>
          <received-date>20171113T180000-0500</received-date>
          <lastchanged-date>20171113T180043-0500</lastchanged-date>
          <source code="PR_Newswire_EN" name="PR Newswire" short-name="PR Newswire"></source>
          <packages>...</packages>
          <references></references>
          <business-relevance>0</business-relevance>
          <dup>0</dup>
          <wordcount>617</wordcount>
          <headline>Standard Chartered to give clients an edge with banking-savvy chatbot powered by Kasisto</headline>
          <deckline>Hong Kong to see initial deployment of chatbot powered by Kasisto's conversational AI platform, other markets to follow</deckline>
          <dateline>HONG KONG and NEW YORK, Nov. 13, 2017</dateline>
          <language code="en"/>
          <summary>HONG KONG and NEW YORK, Nov. 13, 2017 /PRNewswire/ -- In an innovative move that will bring new convenience to its clients, Standard Chartered plans to deploy a chatbot on its online and mobile banking platforms and websites. Powered by Kasisto's conversational artificial intelligence (AI) platform, KAI Banking, the chatbot will act as a virtual personal assistant to help clients manage money, ...</summary>
        </result>
        <result score="0.15864123">...</result>
        <result score="1.0">
          <id>lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn</id>
          <storyURL>https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3</storyURL>
          <type code="News"/>
          <publication-date>20171113T120000-0500</publication-date>
          <received-date>20171113T120000-0500</received-date>
          <lastchanged-date>20171113T120128-0500</lastchanged-date>
          <source code="PR_Newswire_EN" name="PR Newswire" short-name="PR Newswire"></source>
          <packages>...</packages>
          <references>...</references>
          <business-relevance>0</business-relevance>
          <dup>0</dup>
          <wordcount>1110</wordcount>
          <headline>Intel and ICETech -- Artificial Intelligence is changing the social security</headline>
          <dateline>BEIJING, Nov. 13, 2017</dateline>
          <language code="en"/>
          <summary>
          BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ...</summary>
        </result>
        <result score="0.109989956">...</result>
        <result score="0.26772544">...</result>
        <result score="0.18015312">...</result>
        <result score="0.09445275">...</result>
        <result score="0.39723316">...</result>
      </results>
    </searchResults>
  3. Add first story to folder.
    Use the storyfolder/addstory API to add the first story with key value AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0 to the selected folder with ID 17791.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/addstory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791">
        <story id="52952" order="1" status="PENDING" dateAdded="20171120T103848-0500" publicationDate="20171113T180000-0500" receivedDate="20171113T180000-0500" title="Standard Chartered to give clients an edge with banking-savvy chatbot powered by Kasisto" summary="HONG KONG and NEW YORK, Nov. 13, 2017 /PRNewswire/ -- In an innovative move that will bring new convenience to its clients, Standard Chartered plans to deploy a chatbot on its online and mobile banking platforms and websites. Powered by Kasisto's conversational artificial intelligence (AI) platform, KAI Banking, the chatbot will act as a virtual personal assistant to help clients manage money, ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0" storyGUID="1zliV5EWsVsjtRgzXSz_U1XPsNDg8fJnvAGmuufWk1UvxGkUbpS9RRlXzHu1JBwt" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="617"/>
      </storyfolder>
    </opens-api>
  4. Add second story to folder.

    The key value for the second story is pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/addstory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791">
        <story id="52953" order="2" status="PENDING" dateAdded="20171120T110357-0500" publicationDate="20171113T120000-0500" receivedDate="20171113T120000-0500" title="Intel and ICETech -- Artificial Intelligence is changing the social security" summary="BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3" storyGUID="lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="1110"/>
      </storyfolder>
    </opens-api>
  5. List stories in the folder.
    Use the storyfolder/liststories API to review the stories added to the folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder sort="RANK" autofillActiveDelay="" id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="" autofillSearchName="" autofillMode="manual" autofillDepth="0" autofillCount="0" count="2">
        <story id="52953" order="2" status="PENDING" dateAdded="20171120T110357-0500" publicationDate="20171113T120000-0500" receivedDate="20171113T120000-0500" title="Intel and ICETech -- Artificial Intelligence is changing the social security" summary="BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3" storyGUID="lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="1110"/>
        <story id="52952" order="1" status="PENDING" dateAdded="20171120T103848-0500" publicationDate="20171113T180000-0500" receivedDate="20171113T180000-0500" title="Standard Chartered to give clients an edge with banking-savvy chatbot powered by Kasisto" summary="HONG KONG and NEW YORK, Nov. 13, 2017 /PRNewswire/ -- In an innovative move that will bring new convenience to its clients, Standard Chartered plans to deploy a chatbot on its online and mobile banking platforms and websites. Powered by Kasisto's conversational artificial intelligence (AI) platform, KAI Banking, the chatbot will act as a virtual personal assistant to help clients manage money, ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0" storyGUID="1zliV5EWsVsjtRgzXSz_U1XPsNDg8fJnvAGmuufWk1UvxGkUbpS9RRlXzHu1JBwt" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="617"/>
      </storyfolder>
    </opens-api> 

Managing stories in a folder
Ordering stories in a folder
Managing story life-cycle
Ordering stories in a folder
  1. Changing the order of a story.
    When the story folder is first created, the default is to sort headlines based on RANK, which means the most recently added story is assigned the highest order value and appears as the top story in the folder. To change the order of stories in the folder, use the storyfolder/updatestory with optional parameter order. From the previous example, there were two headlines listed in the folder. The story at the top of the list with ID number "52953" has order value two. Change the order value for this story to one will cause it to appear at the bottom of the story folder list.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/updatestory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=52953&order=1

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  2. Confirm stories were re-ordered in the folder.
    Use storyfolder/liststories to retrieve a list of the stories in the folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder sort="RANK" autofillActiveDelay="" id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="" autofillSearchName="" autofillMode="manual" autofillDepth="0" autofillCount="0" count="2">
        <story id="52952" order="2" status="PENDING" dateAdded="20171120T103848-0500" publicationDate="20171113T180000-0500" receivedDate="20171113T180000-0500" title="Standard Chartered to give clients an edge with banking-savvy chatbot powered by Kasisto" summary="HONG KONG and NEW YORK, Nov. 13, 2017 /PRNewswire/ -- In an innovative move that will bring new convenience to its clients, Standard Chartered plans to deploy a chatbot on its online and mobile banking platforms and websites. Powered by Kasisto's conversational artificial intelligence (AI) platform, KAI Banking, the chatbot will act as a virtual personal assistant to help clients manage money, ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0" storyGUID="1zliV5EWsVsjtRgzXSz_U1XPsNDg8fJnvAGmuufWk1UvxGkUbpS9RRlXzHu1JBwt" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="617"/>
        <story id="52953" order="1" status="PENDING" dateAdded="20171120T110357-0500" publicationDate="20171113T120000-0500" receivedDate="20171113T120000-0500" title="Intel and ICETech -- Artificial Intelligence is changing the social security" summary="BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3" storyGUID="lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="1110"/>
      </storyfolder>
    </opens-api> 
  3. Change the folder setting to automatically sort stories.

    The story folder can be set to automatically sort the headlines in the folder based on the story date. A story has three different dates,

    • received date - date story was received by Acquire Media,
    • publication date - publication date as determined by the publisher, and
    • date added to folder.

    Any one of these can be used as the sort key.

    In this example, use the storyfolder/update to set the folder to order stories based on the story publication date, i.e. the most recently published article appears at the top of the list.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&sort=pubdate

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  4. Review headlines in the folder.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder sort="PUBDATE" autofillActiveDelay="" id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="" autofillSearchName="" autofillMode="manual" autofillDepth="0" autofillCount="0" count="2">
        <story id="52952" order="2" status="PENDING" dateAdded="20171120T103848-0500" publicationDate="20171113T180000-0500" receivedDate="20171113T180000-0500" title="Standard Chartered to give clients an edge with banking-savvy chatbot powered by Kasisto" summary="HONG KONG and NEW YORK, Nov. 13, 2017 /PRNewswire/ -- In an innovative move that will bring new convenience to its clients, Standard Chartered plans to deploy a chatbot on its online and mobile banking platforms and websites. Powered by Kasisto's conversational artificial intelligence (AI) platform, KAI Banking, the chatbot will act as a virtual personal assistant to help clients manage money, ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=AyKeq-MhZUQJCAFuJPS-Uo4-I0ppvmtjkzM357xqGDx1KJKDOv6Fb__OV-m06BHYgzyd0B4vu3ucu77R7vkQhWj_VNrJd_UkKVyJnmOVZLj_7rpJGrP83o350_Le_-W0" storyGUID="1zliV5EWsVsjtRgzXSz_U1XPsNDg8fJnvAGmuufWk1UvxGkUbpS9RRlXzHu1JBwt" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="617"/>
        <story id="52953" order="2" status="PENDING" dateAdded="20171120T110357-0500" publicationDate="20171113T120000-0500" receivedDate="20171113T120000-0500" title="Intel and ICETech -- Artificial Intelligence is changing the social security" summary="BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3" storyGUID="lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="1110"/>     
      </storyfolder>
      </opens-api>
Managing story life-cycle

Story status is assigned once the story is added to a folder. The status is used to manage content life-cycle. Depending on the folder pendingDelay setting, stories are marked as PENDING or immediately set to ACTIVE. When PENDING, the story can be considered as on-hold, awaiting review by an editor. ACTIVE stories may be considered ready for display to readers. Lastly, updating an ACTIVE story to the STORED status would allow older stories to be "archived" in the folder.

If a story folder is linked to a saved search, there are two additional allowed status values. See the Linking a Saved Search to a folder example below.

  1. Change the status for a story.

    With the earlier example under Managing Story Folders, the pendingDelay was set to mark stories as PENDING, requiring further action in order to change a story to a status of ACTIVE. For the two stories added to the My Stories folder with ID 17791, those are currently set to status PENDING. Here the storyfolder/updatestory API is used to change one of the stories to ACTIVE status.

    Note that the storyfolder story ID value is used with the storyfolder/updatestory API.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/updatestory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=52953&status=ACTIVE

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  2. Delete a story.
    The story folder expiry value determines how many days a story shall remain in the folder. After this period, calculated based on the dateadded, the system removes the story from the folder. To remove a story before its expiry, use the storyfolder/deletestory API.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/deletestory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=52952

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>

Linking a Saved Search to a folder

This example shows how to link a saved search to a folder and with the autofill parameter, execute the search to select stories for inclusion in the folder. Use storyfolder/addstory to add the stories marked with status as PENDING, ACTIVE or EXCLUDED. If more stories are needed, send another autofill request to find additional candidate stories.

Alternatively, if you wish the search results to be automatically added to the story folder, then link the saved search and set the autofillMode to automatic. In this case, the system automatically adds stories to the folder, using the autofillActiveDelay period, determines when to transition stories to the STORED status and upon the next storyfolder/liststories API request, the system re-fills the folder with new stories from the saved search.

Prepare story folder for autofill "manual" workflow
Adding stories to folder when autofill mode is "manual"
Prepare story folder for autofill "automatic" workflow
Adding stories to folder when autofill mode is "automatic"
Prepare story folder for autofill "manual" workflow
  1. Review autofill settings.

    Use the storyfolder/info API to retrieve the folder settings and check the elements pertinent to the autofill feature: autofillMode, autofillSearchID, autofillDepth, pendingDelay and activeDelay.

    In the response below, note:

    • autofillSearchId is the saved search linked to this folder. Here, a search has not been linked.
    • autofillMode="manual" means stories are not added automatically to the folder. To retrieve candidate stories, submit storyfolder/liststories API request with optional parameter autofill=1 to execute the linked saved search
    • autofillDepth sets the number of ACTIVE stories and is used to calculate how many search results to return, i.e. the autofillCount.
    • pendingDelay determines if the story is immediately assigned the PENDING or ACTIVE status or if the story remains as PENDING for a number of days before changing to ACTIVE.
    • activeDelay defines how many days a story remains ACTIVE before the system changes the status to STORED. Ideally, an autofill request is submitted before all the ACTIVE stories are set to STORED.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/info?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="" autofillSearchName="" autofillMode="manual" autofillDepth="0" autofillCount="0" count="1">
        <sharing value=""/>
        <pending-delay value="-1"/>
        <active-delay value="7"/>
        <autofillActiveDelay value=""/>
        <expiry value="30"/>
        <writeability value=""/>
        <manageability value="NONE"/>
        <description value="Stories for my homepage"/>
        <sort value="PUBDATE"/>
      </storyfolder>
    </opens-api>
  2. Identify a saved search.
    Use the savedsearch/list API to find the saved search for this folder.

    Request
    https://secure.newsedge.com/opensapi/20/savedsearch/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

    Response
    <opens-api>
      <status>OK</status>
      <savedsearches>
        <savedsearch ss="12853" owner="Acquire Media OPENS API" level="ACCOUNT" name="Pharmaceutical Industry" permission="READ" lastModified=""/>
        <savedsearch ss="14552" owner="API User" level="PERSONAL" name="Artificial Intelligence" permission="WRITE" lastModified="20171121T135249-0500"/>
        <savedsearch ss="13819" owner="API User" level="PERSONAL" name="Drug Trials" permission="WRITE" lastModified="20160526T093914-0400"/>
        . . .
      </savedsearches>
    </opens-api>
  3. Link saved search to folder.
    With the storyfolder/update, modify the folder settings to link the saved search with ID=14552 from the previous example, to the story folder ID=17991.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&autofillSearchId=14552

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  4. Modify folder autofill settings
    Set the folder autofillDepth which is used to determine the minimum number of ACTIVE stories to retain in the folder. When the minimum threshold is exceeded, the autofill API request will no longer retrieve candidate stories.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&autofillDepth=5

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
Adding stories to folder when autofill mode is "manual"
  1. Run the autofill request.

    Use the storyfolder/liststories API with the autofill parameter to retrieve candidate stories from the linked saved search. The number of candidate stories is indicated by the storyfolder attribute autofillCount and it represents the difference between the autofillDepth and the number of ACTIVE stories in the folder.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&autofill=1

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder sort="PUBDATE" autofillActiveDelay="" id="17791" owner="API User" name="My Stories" autofillSearchId="14552" autofillSearchName="Artificial Intelligence" autofillMode="manual" autofillDepth="5" autofillCount="4" count="6">
        <story status="AUTOFILLED" publicationDate="20171113T221600-0500" receivedDate="20171113T221600-0500" title="AI, Combined Actions and Digital Strategies | @ExpoDX #AI #Cloud #DigitalTransformation" summary=" Fingerspitzengefühl: A German word used to describe the ability to maintain attention to detail in an ever-changing operational and tactical environment by maintaining real-time situational awareness. The term is synonymous with the English expression of "keeping one's finger on the pulse". The prob..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=JD1CrE2HxAkYF1iwdbVePnLRdXVsP-Te_qpNuE0fJjSHIPgRTCeUGFcOFj6qJi0XxvnkptgB_cWfi3drDT8Vx_npeivz-DwSh4gmRbOOrD8fqu1yUmo2rqcWOOOzYv9728L8Xqv9e853RdoJJRI85hOZ7F_ehKvtHoSet_g476g*" storyGUID="bzqFGkdbb1RzYrrJNqNdvEk-hUf7qrTNQvDQXlH9doVuqVlzLY96PwShLyTIAkKLCPv8XhOOeEuC_ykCf7sRS25J3Z0zaSyccDMUF49m_a4*" storyType="pub-source" sourceName="iPhone Developer's Journal" shortSourceName="iPhone Developer's Journal" sourceCode="SPD_iPhoneDevsJr" byline="" copyright="" />
        <story status="AUTOFILLED" publicationDate="20171114T000100-0500" receivedDate="20171113T212837-0500" title="WORKING WITH ROBOTS" summary=" EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**" storyGUID="d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**" storyType="licensed" sourceName="New Straits Time (Malaysia)" shortSourceName="New Straits Time" sourceCode="New_Straits_Time" byline="Dwintha Maya Kartika" copyright="(c) 2017 New Straits Times Publishing Co." wordcount="827"/>
        <story status="AUTOFILLED" publicationDate="20171113T211900-0500" receivedDate="20171113T211900-0500" title="Report: AWS Soon To Unveil Upgraded Artificial Intelligence Portfolio" summary=" The project, code-named "Ironman", reportedly involves an effort internally and with startup partners to even the artificial intelligence playing field with Microsoft and Google...." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=iH6UKRcjGbKceyh5AgHZ23y1IWVtXrwC1R5clj6UH2mfsepENhYe-0-LICmd7jIVIQEDYosthZaX-djZERSVIv7vhE1aqBZ8-Oh3xSamKkefW2lEq0ua_enxaAyXJnIFufOGz-7Olbd_ZbrQQGE8YsTphryHnqhHvHB1JBfOSkw*" storyGUID="GJ-Q4dBdK0h1FNImhe_JB0M3CSx-Wc9eQJsMitn79Y4Ag76sYAkQ5OPuvC8Ic-hUfMZx03ji5SsA6NSrlSvx7g2fD9EdkLOMAiOvoPUo1NQ*" storyType="pub-source" sourceName="CRN (US)" shortSourceName="CRN" sourceCode="SPD_CRNMagazine" byline="" copyright="" />
        <story status="AUTOFILLED" publicationDate="20171113T204600-0500" receivedDate="20171113T204600-0500" title="Exclusive: Robot junior clerk already processing hundreds of bookings and reducing human working hours" summary=" Billy Bot, the ‘robot junior clerk’, is now managing up to 100 new instructions a day from solicitors and members of the public, agreeing fees, booking cases, checking for conflicts and even making the coffee. The time the system saves has already meant that the clerks at Clerksroom have to work few..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=gSRrT0P9tkL-IQnpxr7GcUcUd6lash89ewGFuTIRibmz4MQssLrHCZfTCPdaSURZ65ddcC_O6jkBpa7LJCdN2Gtt1uq4yiSr6M9xzQ_0kxqONErDpBoFqcvclj3HHGZLGAQPmaSK-jm_cU7kgJdkf1poTy9EQjnGlkWZNyCLsek*" storyGUID="n0gbr69srfODEIf5e-txqVnJYIyV-3oxHZaMmh2jbmVUf1Zvkq34KkclESK-c1S4OibbBqvW_ll20p-FsXmXz5G5avE_goWLbDeHohIpKFY*" storyType="pub-source" sourceName="Legal Futures" shortSourceName="Legal Futures" sourceCode="SPD_legalfut" byline="" copyright="" />
        <story id="52954" order="2" status="PENDING" dateAdded="20171121T090435-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T231042-0500" title="Sequoia invests £40m in Bristol-based AI startup" summary="Silicon Valley investment giant Sequoia Capital has pumped $50m (£38m) into Bristol-headquartered artificial intelligence chip producer Graphcore – a major vote of confidence in the UK’s booming startup scene. Sequoia is best known as an early investor in some of the technology sectors’ most prominent names – including Apple, Oracle, Yahoo, Google, YouTube, PayPal, Instagram, WhatsApp and ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=hm3DJJduJYwG7Tasy7FqBMbBxe--w-TnnKtpF1M1iR7Hw9TB5g1pbE9oZ0lhfzAz4E3qD0BtjP_6l3RIgr4uoeoIxky21t_nTxuKrFzUIYh7CAoayX45Q4NeA3al56e24tWTkVkDmWycHfgBOaBEPZ9gm-ug7okHAlKYTMeQJGI*" storyGUID="ADlF7qzwy3hOcDOlruVYueJhQ7RdQjbQ2-mDYZvoRIYSddOFsRFWwhgDXuSEfVLbiltoA5toiqV2aC7KspeXqo5EsOPKW4uctflHQ2F2DEM*" storyType="licensed" sourceName="Independent" shortSourceName="Independent" sourceCode="Independent_UK" byline="" copyright="(c) 2017 Independent News and Media Limited" wordcount="288"/>
        <story id="52953" order="1" status="ACTIVE" dateAdded="20171120T110357-0500" publicationDate="20171113T120000-0500" receivedDate="20171113T120000-0500" title="Intel and ICETech -- Artificial Intelligence is changing the social security" summary="BEIJING, Nov. 13, 2017 /PRNewswire/ -- At 1:00 pm on October 29, 2017, Intel "Artificial Intelligence Changes Security" Summit was held at Sheraton Hotel in Shenzhen. At the conference, Intel announced that, in conjunction with the leading AI+ solution provider ICETech, NVR and IPC based video-structured solutions will be released. ICETech deep learning video structure algorithm, based on ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=pcbSaFnJYjIup2HChJEQ-P_kqKNks_2K0fG3W7VAtCVGyqmgNArTUs_F2vH74Svt7UmfcIHCiaCixQ6mLV0fICcqhGMudwOCSkQUfbT9ZQeXsszQ8ab9MDivVfaPQmW3" storyGUID="lb6TWHgYLGfmOqHrEoLrvcto-OfRDcu3QZ9K9DUVZFCcG34gQeE4gojBrALiafbn" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="1110"/>
      </storyfolder>
    </opens-api>
  2. Add story to folder.

    From the AUTOFILLED storyURL, copy the key string then make a request to the storyfolder/addstory API with the story parameter using this key as its value.

    The status assigned to the newly added story is PENDING, ACTIVE, or STORED depending on the folder's pendingDelay and activeDelay settings. If you wish to override the system-assigned status then include the optional parameter status with this add story request.

    In the example here, the story was added to the folder without the optional status parameter, therefore, using the folder pendingDelay setting to mark the story with PENDING status.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/addstory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791">
        <story id="52965" order="3" status="PENDING" dateAdded="20171129T135645-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T212837-0500" title="WORKING WITH ROBOTS" summary="EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**" storyGUID="d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**" storyType="licensed" sourceName="New Straits Time (Malaysia)" shortSourceName="New Straits Time" sourceCode="New_Straits_Time" byline="Dwintha Maya Kartika" copyright="(c) 2017 New Straits Times Publishing Co." wordcount="827"/>
      </storyfolder>
    </opens-api>
  3. Change story to ACTIVE status.
    As found in the previous example, the story was marked with status PENDING when it was added without the status parameter. To make the story ACTIVE, submit the storyfolder/updatestory request with status parameter.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/updatestory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=52965&status=ACTIVE

    Response
    <opens-api>
      <status>OK</status>          
    </opens-api>
  4. Exclude story from folder.

    When the autofill parameter returns candidate stories, a story with status AUTOFILLED may have been previously presented as a candidate story. To prevent the same story from being returned, add this story to the folder and mark the status as EXCLUDED.

    In this example, the AUTOFILLED story titled "Exclusive: Robot junior clerk already processing hundreds of bookings and reducing human working hours" with key gSRrT0P9tkL-IQnpxr7GcUcUd6lash89ewGFuTIRibmz4MQssLrHCZfTCPdaSURZ65ddcC_O6jkBpa7LJCdN2Gtt1uq4yiSr6M9xzQ_0kxqONErDpBoFqcvclj3HHGZLGAQPmaSK-jm_cU7kgJdkf1poTy9EQjnGlkWZNyCLsek* will be excluded. To exclude a story, use the storyfolder/addstory API with optional parameter status and value EXCLUDED.


    Request
    >https://secure.newsedge.com/opensapi/20/storyfolder/addstory?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&story=gSRrT0P9tkL-IQnpxr7GcUcUd6lash89ewGFuTIRibmz4MQssLrHCZfTCPdaSURZ65ddcC_O6jkBpa7LJCdN2Gtt1uq4yiSr6M9xzQ_0kxqONErDpBoFqcvclj3HHGZLGAQPmaSK-jm_cU7kgJdkf1poTy9EQjnGlkWZNyCLsek*&status=EXCLUDED

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder id="17791">          
        <story id="52970" order="0" status="EXCLUDED" dateAdded="20171201T143749-0500" publicationDate="20171113T204600-0500" receivedDate="20171113T204600-0500" title="Exclusive: Robot junior clerk already processing hundreds of bookings and reducing human working hours" summary=" Billy Bot, the ‘robot junior clerk’, is now managing up to 100 new instructions a day from solicitors and members of the public, agreeing fees, booking cases, checking for conflicts and even making the coffee. The time the system saves has already meant that the clerks at Clerksroom have to work few..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=gSRrT0P9tkL-IQnpxr7GcUcUd6lash89ewGFuTIRibmz4MQssLrHCZfTCPdaSURZ65ddcC_O6jkBpa7LJCdN2Gtt1uq4yiSr6M9xzQ_0kxqONErDpBoFqcvclj3HHGZLGAQPmaSK-jm_cU7kgJdkf1poTy9EQjnGlkWZNyCLsek*" storyGUID="n0gbr69srfODEIf5e-txqVnJYIyV-3oxHZaMmh2jbmVUf1Zvkq34KkclESK-c1S4OibbBqvW_ll20p-FsXmXz5G5avE_goWLbDeHohIpKFY*" storyType="pub-source" sourceName="Legal Futures" shortSourceName="Legal Futures" sourceCode="SPD_legalfut" byline="" copyright="" />
      </storyfolder>
    </opens-api>
Prepare story folder for autofill "automatic" workflow
  1. Set the folder to fill with stories automatically.

    After creating a new story folder, use the storyfolder/update API to define the search and settings to automatically insert stories into the folder. The use of optional parameters, autofillMode, autofillSearchId, autofillDepth and autofillActiveDelay will be defined. Once defined, each time the story folder is called with the storyfolder/liststories API, a number of ACTIVE stories are returned in the folder; the number of ACTIVE stories to match the autofillDepth value. If autofillActiveDelay period is exceeded for any ACTIVE story, the story changes to the STORED status and the autofillSearchId will be used to return newer articles replacing the STORED article.

    In this example, this new folder ID 17792 will be linked to the saved search "Artificial Intelligence" search ID 14552. We want the folder to always show 3 ACTIVE stories and these stories will remain ACTIVE for 60 minutes, which is defined by the autofillActiveDelay value (minimum value is 15 minutes).


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17792&autofillMode=automatic&autofillActiveDelay=60&autofillSearchId=14552&autofillDepth=3

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
Adding stories to folder when autofill mode is "automatic"
  1. Automatically add stories to the folder.

    Use the storyfolder/liststories API to request the stories from the folder. If there are fewer than 3 ACTIVE stories in the folder, or it is empty, this action executes the linked saved search and up to 3 stories will be added to the folder, each with status ACTIVE and dateadded value of the current date and time. If the folder already has 3 stories with status as ACTIVE, this request simply returns the list of stories.


    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17792

    Response
    <opens-api>
      <status>OK</status>
      <storyfolder sort="RANK" autofillActiveDelay="15" id="17792" owner="API User" name="Industry News" permission="READ|WRITE|MANAGE" autofillSearchId="14552" autofillSearchName="Artificial Intelligence" autofillMode="automatic" autofillDepth="3" autofillCount="0" count="6">
        <story id="52973" order="6" status="ACTIVE" dateAdded="20171201T145140-0500" publicationDate="20171201T140000-0500" receivedDate="20171201T140000-0500" title="Hartford InsurTech Hub Announces Startup Cohort Set to Transform U.S. Insurance Capital into New InsurTech Giant" summary=" HARTFORD, Conn. (PRWEB) December 01, 2017 Hartford InsurTech Hub, powered by Startupbootcamp, unveils the 2018 cohort of startups for its inaugural acceleration program. Artificial Intelligence (AI), Big Data Analytics and Natural Language Processing combined with Cyber Security, Smart Home and Health Insurance, to name but a few, display the diverse range of technologies and insurance types ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=A_BBRdZZClDgIbc9RSx5RhdQpq6UsWe_EGuXgadj90PRR4kMOsX84tVLdmrMkIpA3efztJyyxoJe4sHA8Q6je2xSHCfKhyRLAjHFcvaw_HQpgEv2ZpNVjj_CkoxMRdNDgQ1pS-Lpsv-iptsZh7LmPQ**" storyGUID="FcqOIvdSCheUYYBZL1vBOZBkqa1gs4JpsDiMbABnMw8IMHAVTo_qYzs9hMoLJEE_2w3I712csCJ8vvCHVGNQzQ**" storyType="licensed" sourceName="PR Web" shortSourceName="PR Web" sourceCode="PR_Web" byline="" copyright="" wordcount="945"/>
        <story id="52972" order="5" status="ACTIVE" dateAdded="20171201T145140-0500" publicationDate="20171201T123000-0500" receivedDate="20171201T123000-0500" title="Artificial Intelligence has seen plenty of traction in the press, but many corporations are still trying to figure…" summary=" TWEET Artificial Intelligence has seen plenty of traction in the press, but many corporations are still trying to figure… https://t.co/40zt1rO1tx COMPANY IDENTIFIED Morgan Stanley (NYSE:MS) TWEETER Morgan Stanley -- @MorganStanley TWEETER DESCRIPTION Official Twitter account of Morgan Stanley. We provide a range of investment banking, securities, investment management & wealth management ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=ujUbE__TD9fxi9OaH8i4-uiuIZJWwGwIVkBTcr5ylKd88z-wjZ_CgQvS6CCydqZlk6GlEI1IHYKcMW4qLLzUK6ggrDO-1XeON8aLQbk0OGeBWhwhrqpldudEHZ3Mx_N5-A_fSJLi3ElFTZWNtJ0nmLXro_IB5dSDtDceWBQkQaE*" storyGUID="8hSYi7f_3uLKQe0oRDvG2TqB6cchI8bGTkViSjLwXygTPxpldnqV6jTr1konzE4VlcMtc42wKBcquqXM9HWZJB8J_C7aroNaWBno2rZJgCI*" storyType="licensed" sourceName="People Are Talking -- Official Corporate Tweets" shortSourceName="People Are Talking -- Official Corporate Tweets" sourceCode="People_Talk_Corp" byline="" copyright="" wordcount="94"/>
        <story id="52971" order="4" status="ACTIVE" dateAdded="20171201T145140-0500" publicationDate="20171201T104500-0500" receivedDate="20171201T104500-0500" title="SparkCognition recognized as a 2017 Red Herring Top 100 Global Awardee" summary=" AUSTIN, Texas, Dec. 1, 2017 /PRNewswire/ -- SparkCognition, an Artificial Intelligence (AI) company based in Austin, Texas, is named in the 2017 Red Herring Top 100 Global. The award is given to the top, private technology companies in Europe, North America and Asia, acknowledging the most innovative and impactful brands around the world. In June, SparkCognition also announced it was named in ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=PUfoTICSiwJzaK8I-Vsq-hpNZHmocKuBfkumJ7ns7AW5kmEX6qfOVKKjPq0GUynpvOYhwUjGxBlMSgh5HmTz_og6UwT5mOopL79JqOpMBiZhoqf6VXMkaxMSzytcCFFm" storyGUID="AROdvlhXVhq6k9O4z0FtaKn_iCMRvBUkI9v6zvyjV5aXHT-51XQ8pg5KWz1cOGRg" storyType="licensed" sourceName="PR Newswire" shortSourceName="PR Newswire" sourceCode="PR_Newswire_EN" byline="" copyright="" wordcount="444"/>
        <story id="52969" order="3" status="STORED" dateAdded="20171129T155602-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T231042-0500" title="Sequoia invests £40m in Bristol-based AI startup" summary=" Silicon Valley investment giant Sequoia Capital has pumped $50m (£38m) into Bristol-headquartered artificial intelligence chip producer Graphcore – a major vote of confidence in the UK’s booming startup scene. Sequoia is best known as an early investor in some of the technology sectors’ most prominent names – including Apple, Oracle, Yahoo, Google, YouTube, PayPal, Instagram, WhatsApp and ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=2Xpbg_7IoMDxuS-CT-Hfkp2TMiWVduPtRijsCTXQFJ6liyzbw6jyolW19J2nYRnxPWANt7WnY7a2ja4of1udaAuLm7U8fzrgVw9zIi5UATbfSNpSFxYZS17kd42N27J0gNtFGPAccSYBGlnPcqgm-WTkg0cC7DMngevjpNO_zPE*" storyGUID="ADlF7qzwy3hOcDOlruVYueJhQ7RdQjbQ2-mDYZvoRIYSddOFsRFWwhgDXuSEfVLbiltoA5toiqV2aC7KspeXqo5EsOPKW4uctflHQ2F2DEM*" storyType="licensed" sourceName="Independent" shortSourceName="Independent" sourceCode="Independent_UK" byline="" copyright="(c) 2017 Independent News and Media Limited" wordcount="288"/>
        <story id="52968" order="2" status="STORED" dateAdded="20171129T155602-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T212837-0500" title="WORKING WITH ROBOTS" summary=" EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**" storyGUID="d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**" storyType="licensed" sourceName="New Straits Time (Malaysia)" shortSourceName="New Straits Time" sourceCode="New_Straits_Time" byline="Dwintha Maya Kartika" copyright="(c) 2017 New Straits Times Publishing Co." wordcount="827"/>
        <story id="52967" order="1" status="STORED" dateAdded="20171129T155602-0500" publicationDate="20171113T180000-0500" receivedDate="20171113T180000-0500" title="NVIDIA Chosen by Every Major Computer Maker, Every Major Cloud" summary=" DENVER, Nov. 13, 2017 (GLOBE NEWSWIRE) -- NVIDIA today announced the world’s most advanced data center GPU — the NVIDIA® Tesla® V100 GPU based on NVIDIA’s Volta architecture — is available through every major computer maker and chosen by every major cloud to deliver artificial intelligence and high performance computing. Dell EMC, Hewlett Packard Enterprise, Huawei, IBM and Lenovo have all ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=i7nfML9Yyg7fplgnxDuLWybnb2Ss5RJJopee8mgnVYGeFNOXn1Z0pMjmuc8vSgieLnrwbO0xFJRnf4OF2rR_DKwshCTYLUapxMEZG79kN93fs01qWlgVlxQC4QvswY5y" storyGUID="_uNI-Xko7gu6dG4RGUpTqaG4L-bs1IYD8D1S0qkhM8vW5ZPtryHrzeDvsbho1ZoH" storyType="licensed" sourceName="GlobeNewswire" shortSourceName="GlobeNewswire" sourceCode="PrimeNewswire" byline="" copyright="" wordcount="999"/>
      </storyfolder>
    </opens-api>

Accessing Story Folder contents
Stories collected in the Story Folder can be retrieved with the storyfolder/liststories API request. Alternatively, the story folder contents may be accessed as an RSS feed or linked to a Web News Widget.
Requesting the story folder
Viewing the story folder contents as an RSS feed
Linking the story folder to a Web News Widget
Requesting the story folder
  1. List story folders.
    Find the story folder ID with the storyfolder/list API request. In the returned results, note each storyfolder element and its count attribute which indicates how many stories are found in the folder. The count includes stories with any status, PENDING, ACTIVE or STORED.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

    Response
    <opens-api>
      <status>OK</status>
      <storyfolders count="3">
        <storyfolder id="17792" order="3" count="6" sharing="" name="Industry News" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="RANK"/>
        <storyfolder id="17791" order="2" count="4" sharing="" name="My Stories" description="Stories for my homepage" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="PUBDATE"/>
        <storyfolder id="17785" order="1" count="1" sharing="" name="My Stories manual fill" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="DATEADDED"/>
      </storyfolders>
    </opens-api>
  2. View stories in a folder.
    With the folder ID from the previous example, submit the storyfolder/liststories request to list stories contained in the folder. Adding the optional parameter status to the request will filter stories by status.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=935DA0B364E9E130F0EC3827FC3CCC9C&folder=17791&status=ACTIVE

    Response
     <opens-api>
      <status>OK</status>
      <storyfolder sort="PUBDATE" autofillActiveDelay="" id="17791" owner="API User" name="My Stories" permission="READ|WRITE|MANAGE" autofillSearchId="14552" autofillSearchName="Artificial Intelligence" autofillMode="manual" autofillDepth="5" autofillCount="0" count="2">
        <story id="52965" order="3" status="ACTIVE" dateAdded="20171129T135645-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T212837-0500" title="WORKING WITH ROBOTS" summary="EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**" storyGUID="d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**" storyType="licensed" sourceName="New Straits Time (Malaysia)" shortSourceName="New Straits Time" sourceCode="New_Straits_Time"  byline="Dwintha Maya Kartika" copyright="(c) 2017 New Straits Times Publishing Co." wordcount="827"/>
        <story id="52966" order="4" status="ACTIVE" dateAdded="20171129T140303-0500" publicationDate="20171114T000100-0500" receivedDate="20171113T202556-0500" title="4As course aims to enlighten firms about AI, VR" summary="KUALA LUMPUR: The Association of Accredited Advertising Agents Malaysia (4As) has organised a specially tailored course for companies to gain the latest knowledge on Artificial Intelligence (AI), Virtual Reality (VR) and Augmented Reality (AR) yesterday. 4As said this knowledge would reshape the next generation of marketing communications. The half-day course, titled "Magic and the Machines - ..." storyURL="https://secure.newsedge.com/opensapi/20/news/read?key=ZeJyebzb_PscH1NUV6IgXRRPYWMkiSJIgpWJx4Ep04LJXWiqv7oYJmuLm67yBd4I9DiVzd0fjpxM3TgvPw-DlyJIfyK6MKtADIUayT6olTIj4COnWqJJCFyKSAmQAeqEDy96TopsdxxOr0pQpQl_sw**" storyGUID="d7v72x1iI6sXcUO3ZZ0YBPxrGDXAnAMxZM3hbjknXP8tzFoZiD5mdLLwTl3Zc21_C-OGn_HtrIDMrjcMX4UGyQ**" storyType="licensed" sourceName="Business Times (Malaysia)" shortSourceName="Business Times" sourceCode="Business_Times_M" byline="" copyright="" wordcount="265"/>
      </storyfolder>
    </opens-api>
  3. Read a story from the folder.
    In the previous step, there were two ACTIVE stories in the My Stories folder. To read the first story, copy the storyURL to submit a news/read request.

    Request
    https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**"

    Response
    <newsedge version="1.0">
      <header>
        <id>d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**</id>
        <storyURL>https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**</storyURL>
        <publish-reason code="original"/>
        <type code="News"/>
        <business-relevance>0</business-relevance>
        <dup>0</dup>
        <wordcount>827</wordcount>
        <publication-date>20171114T000100-0500</publication-date>
        <user-display-publication-date isotimevalue="2017-11-14T05:01:00Z">Tuesday, November 14, 2017</user-display-publication-date>
        <received-date>20171113T212837-0500</received-date>
        <user-display-received-date isotimevalue="2017-11-14T02:28:37Z">Monday, November 13, 2017, 9:28:37 PM EST</user-display-received-date>
        <lastchanged-date>20171113T212838-0500</lastchanged-date>
        <classification>
          <taxonomies>
            <taxonomy code="Subject">
              <classifier code="IS/appsci" grade="C" name="Science and Technology">
                <classifier code="IS/appsci.tech" grade="C" name="Technology">
                  <classifier code="IS/appsci.artintel" grade="C" name="Artificial Intelligence"></classifier>
                  <classifier code="IS/appsci.robotic" grade="C" name="Robotics Technology"></classifier>
                </classifier>
              </classifier>
            </taxonomy>
          </taxonomies>
          <entities>
            <entity-list code="Organization">
              <entity name="World Economic Forum LLC">
                <property code="acorn">0609446978</property>
                <property code="uacorn">3882283838</property>
                <property code="use">mention</property>
              </entity>
              <entity name="The World Bank Group">
                <property code="acorn">3369619786</property>
                <property code="uacorn">3449066947</property>
                <property code="use">mention</property>
              </entity>
            </entity-list>
            <entity-list code="Person">
              <entity name="Dwintha Maya Kartika">
                <property code="use">author</property>
              </entity>
            </entity-list>
          </entities>
        </classification>
        <source short-name="New Straits Time" name="New Straits Time (Malaysia)" code="New_Straits_Time">
          <provider name="New Straits Times" code="NST_____">
            <service name="Newspapers" code="NST_News"/>
          </provider>
          <topness code="TRUE"/>
          <content-type name="Newspaper" code="Newspaper"/>
          <media-type name="Text" code="Text"/>
          <rights name="Licensed Feed" code="CLEARED"/>
          <geo-origin>
            <entity name="South-Eastern Asia">
              <property source="xmltag.org" code="loc">RB/seas</property>
              <property code="fullname">South-Eastern Asia</property>
            </entity>
            <entity name="Malaysia">
              <property source="xmltag.org" code="loc">RC/MY</property>
              <property code="fullname">Malaysia</property>
            </entity>
            <entity name="Asia">
              <property source="xmltag.org" code="loc">RR/as</property>
              <property code="fullname">Asia</property>
            </entity>
            <entity name="Kelana Jaya">
              <property source="xmltag.org" code="loc">RU/my..kelana</property>
              <property code="fullname">Kelana Jaya, Malaysia</property>
            </entity>
          </geo-origin>
          <geo-focus>
            <entity name="Malaysia">
              <property source="xmltag.org" code="loc">GC/MY</property>
              <property code="fullname">Malaysia</property>
            </entity>
          </geo-focus>
          <classification>
            <taxonomies>
              <taxonomy code="Subject">
                <classifier code="PX/gen" grade="" name="General News"></classifier>
              </taxonomy>
              <taxonomy code="Industry">
                <classifier code="PI/tech" grade="" name="Technology"></classifier>
              </taxonomy>
            </taxonomies>
          </classification>
        </source>
        <packages>
          <package code="NewsEdge"/>
          <package code="ICS-XL"/>
          <package code="ICS"/>
          <package code="CCS"/>
        </packages>
      </header>
      <asset>
        <newslines>
          <headline>WORKING WITH ROBOTS</headline>
          <byline>Dwintha Maya Kartika</byline>
          <copyrightline>(c) 2017 New Straits Times Publishing Co.</copyrightline>
          <summary>EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ...</summary>
        </newslines>
        <content>
          <block>
            <p lede="true">EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life.</p>
            <p lede="true">Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR.</p>
            <p>While unprecedented technological advancements should instil some optimism for the future of human civilisation, the doom side of automation looms large.</p>
            <p>Whether today's jobs will vanish as computers progress beyond human comprehension, pundits' opinions vary.</p>
            <p><person value="APIN:T000000001">Martin Ford's</person> Rise of the Robots, for instance, painted a blood-curdling apocalypse of mass unemployment as robots will be eating nearly all white-collar jobs. He anticipates a robot evolution similar to the Darwinian natural selection.</p>
            <p>On a more moderate stance, the <org>International Labour Organisation</org> estimated that 56 per cent of employment in five Asean countries are facing the risk of becoming obsolete, especially those involving routine tasks. Jobs requiring social interaction and non-routine tasks cannot easily be replaced by machines.</p>
            <p><person value="APIN:T000000002">Julia Kirby</person> and <person value="APIN:T000000003">Thomas Davenport</person>, in Only Humans Need Apply, in contrast, take a techno-optimistic stance on this much-debated question. The Fourth Industrial Revolution, they argue, is not a zero-sum game between humans and machine, but a sweet spot for collaboration between the two.</p>
            <p>They popularised a term called augmentation, as an antidote to automation; a perspective on how work of humans could be "deepened, rather than diminished, by a greater use of machines".</p>
            <p>From the augmentation perspective, people have five alternatives to realign their contribution in working with machines.</p>
            <p>One, step up - enhancing skills on big-picture thinking and higher level of abstraction. This technique involves letting machines do the work without losing knowledge of how they do it.</p>
            <p>Two, step aside - focusing on interpersonal and intrapersonal intelligence; strengths that are not purely rational and easily codified. People can do so by discovering their social strengths and work on improving them.</p>
            <p>Three, step in - monitor and modify the work of computers; a classic approach by focusing on science, technology, engineering and mathematics education.</p>
            <p>Fourth, step narrowly - finding a niche that wouldn't be economical to automate.</p>
            <p>Fifth, step forward - building the next generation of computing and AI tools.</p>
            <p>This augmentation proposal echoed <org idsrc="xmltag.org" value="ACORN:0609446978">World Economic Forum's</org> assessment on skills deemed important in the 4IR era. Among top 10 skills needed in 2020 that the forum highlighted are complex problem solving, critical thinking, creativity and cognitive flexibility.</p>
            <p>These skills are not innate, but rather nurtured, and many would agree that a change in mindset is required if we were to equip ourselves with these skills. But how, really?</p>
            <p>Individuals and policymakers can start with the basics - training our brains to think better. One practical method is to expand the sets of mental models that humans use to think and make sense of the world.</p>
            <p>Mental models are values, concepts, beliefs and causal narratives about how the world works. Without mental models, it would be impossible for people to make most of their decisions and solve problems.</p>
            <p>For example, supply and demand is a mental model to understand how the economy works. Or, anchoring is a mental model on how individuals use an initial information to form judgments.</p>
            <p>While some mental models are useful, there are those that may persevere even if they outlive their usefulness or were not useful to start with.</p>
            <p><org idsrc="xmltag.org" value="ACORN:3369619786">The World Bank's</org> World Development Report 2015 stressed the importance of exposing people to alternative experiences, ways of thinking and expanding mental models through policy interventions. If countries were to attain a higher socio-economic development, for example, it is crucial to discard the belief that women are not capable of becoming leaders.</p>
            <p>A research by economic historian <person value="APIN:T000000004">Joel Mokyr</person> found that changes in mental models at the societal level were instrumental in preparing the ground for the past Industrial Revolution.</p>
            <p>In the 4IR era, expanding and shifting mental models are needed more than ever. What does this mean for Malaysian policymakers?</p>
            <p>In the 2018 Budget, Prime Minister Datuk Seri <person value="APIN:T000000005">Najib Razak</person> announced that the government would implement the Malaysia Digital Policy as the nation embraces 4IR. This will include, among others, matching grants for businesses and tax incentives for automation equipment.</p>
            <p>This can be strengthened by urging businesses to embrace augmentation. The government could convince employers that the combination of humans and computers is better than viewing them as substitute capitals - dismantling the zero-sum mentality of automation.</p>
            <p>In line with Transformasi Nasional 2050 aspiration, 4IR-ready educational ecosystem should also be fully nurtured. The recently-announced 21st century smart classrooms could be well-equipped with adjustments on teachers' mental models. Teachers ought to re-examine their beliefs about students and their ability to learn, including students with learning difficulties, children from poor families and others.</p>
            <p>Ultimately, 4IR will only be a bountiful force in human history if we could upgrade our mind.</p>
            <p>* The writer is an analyst (economics, trade and regional integration) at the <org>Institute of Strategic & International Studies Malaysia</org></p>
            <p>( END )</p>
          </block>
        </content>
        <language code="en"/>
        <dup-check>19173E</dup-check>
      </asset>
    </newsedge>
Viewing the story folder contents as an RSS feed

The story folder contents represent a set of curated headlines that can be easily be accessed as an RSS feed through a dedicated RSS reader or embedded on a website. Using the rss/get API and the story folder ID, create an URL to retrieve the folder contents as a feed.

The list of available APIs is established for each user by the Acquire Media Administrator. (Some documented API may not be available for your use.)

  1. Preparing the story folder RSS filename.

    With the folder ID, create the RSS filename by concatenating the following values:

    • the user-ID (refer to session/login for the uid)
    • the underscoe (_) character
    • the letters "pa", "pp", "ps", or simply "p" to retrieve the headlines with the respective status ACTIVE, PENDING, STORED, or all ACTIVE, PENDING, and STORED headlines
    • the storyfolder ID (id) from the previous step
    • ".xml" as the file extension

    The RSS filename would be <<user-ID>>_pa17791.xml.

  2. Requesting the RSS feed.

    Request
    https://secure.newsedge.com/opensapi/20/rss/get?file=32594_pa17791.xml

    Response
    <?xml version="1.0" encoding="UTF-8"?>
    <rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/" version="2.0">
      <channel>
        <title>My Stories</title>
        <link>https://secure.newsedge.com/</link>
        <description>"This RSS feed is brought to you by NewsEdge.com"</description>
        <language>en-US</language>
        <lastBuildDate>Fri, 01 Dec 2017 15:28:30 EST</lastBuildDate>
        <generator>NewsEdge.com RSS generator</generator>
        <docs>http://blogs.law.harvard.edu/tech/rss</docs>
        <managingEditor>rss.editing@newsedge.com (Acquire Media NewsEdge)</managingEditor>
        <webMaster>rss.master@newsedge.com (Acquire Media NewsEdge)</webMaster>
        <ttl>15</ttl>
        <item>
          <title>WORKING WITH ROBOTS</title>
          <link>https://secure.newsedge.com/opensapi/20/news/read?key=lMSqry12qXCM74bbCX34e09NJO9sh2H1UMNtlmutbvC0Piyqo5ty3SYs27M31WERfCN1BZcWF7fHP1alNX9PgWcSbTedSsJpHuOdnY5itCGHEF2vF7h4NxbtlMVwASJioN8Yc9W3VXYIKwmPycVkIQ**&amp;client=rssfeed_32966_pa17791&amp;uurp=1</link>
          <guid isPermaLink="false">d7v72x1iI6sXcUO3ZZ0YBC9ixjipxWQpAGaZMUZE0t_4VtD940LCSkWavYyrx6RO7RVedjRre-wN12hFjHUK9Q**</guid>
          <description>EVER since the German concept "Industry 4.0" was coined as the Fourth Industrial Revolution (4IR), the term has become a buzzword penetrating public discourse in all walks of life. Advanced robotics, autonomous cars and artificial intelligence (AI) are among major trends brought by 4IR. While unprecedented technological advancements should instil some optimism for the future of human ...</description>
          <pubDate>Tue, 14 Nov 2017 00:01:00 EST</pubDate>
          <author>New Straits Time</author>
          <dc:creator>Dwintha Maya Kartika</dc:creator>
          <dc:rights>(c) 2017 New Straits Times Publishing Co.</dc:rights>
          <dc:date>2017-11-29T13:56:45-05:00</dc:date>
          <dc:publisher>New Straits Time</dc:publisher>
        </item>
        <item>
          <title>4As course aims to enlighten firms about AI, VR</title>
          <link>https://secure.newsedge.comm/opensapi/20/news/read?key=ZeJyebzb_PscH1NUV6IgXRRPYWMkiSJIgpWJx4Ep04LJXWiqv7oYJmuLm67yBd4I9DiVzd0fjpxM3TgvPw-DlyJIfyK6MKtADIUayT6olTIj4COnWqJJCFyKSAmQAeqEDy96TopsdxxOr0pQpQl_sw**&amp;client=rssfeed_32966_pa17791&amp;uurp=1</link>
          <guid isPermaLink="false">d7v72x1iI6sXcUO3ZZ0YBPxrGDXAnAMxZM3hbjknXP8tzFoZiD5mdLLwTl3Zc21_C-OGn_HtrIDMrjcMX4UGyQ**</guid>
          <description>KUALA LUMPUR: The Association of Accredited Advertising Agents Malaysia (4As) has organised a specially tailored course for companies to gain the latest knowledge on Artificial Intelligence (AI), Virtual Reality (VR) and Augmented Reality (AR) yesterday. 4As said this knowledge would reshape the next generation of marketing communications. The half-day course, titled "Magic and the Machines - ...</description>
          <pubDate>Tue, 14 Nov 2017 00:01:00 EST</pubDate>
          <author>Business Times</author>
          <dc:date>2017-11-29T14:03:03-05:00</dc:date>
          <dc:publisher>Business Times</dc:publisher>
        </item>
      </channel>
    </rss>
Linking the story folder to a Web News Widget

The Web News Widgets API is used to add news headlines to your webpage. The headlines may originate from a saved search or a story folder. Using the widget/create or widget/update APIs, set up a widget to link to headlines collected in a story folder.

For more details about creating and customizing the widgets, see also Web News Widgets API.

The list of available APIs is established for each user by the Acquire Media Administrator. (Some documented API may not be available for your use.)

  1. Get the story folder ID.

    Request
    https://secure.newsedge.com/opensapi/20/storyfolder/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

    Response
    <opens-api>
      <status>OK</status>
      <storyfolders count="2">
        <storyfolder id="17792" order="3" count="6" sharing="" name="Industry News" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="RANK"/>
        <storyfolder id="17791" order="2" count="4" sharing="" name="My Stories" description="Stories for my homepage" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="PUBDATE"/>
        <storyfolder id="17785" order="1" count="1" sharing="" name="My Stories manual fill" description="" owner="API User" level="USER" permission="READ|WRITE|MANAGE" sort="DATEADDED"/>
      </storyfolders>
    </opens-api>
  2. Create a widget
    With the widget/create API and using the defaults for most of the parameters, create a widget to display headlines from the Industry News story folder, ID 17792.

    Request
    https://secure.newsedge.com/opensapi/20/widget/create?session=935DA0B364E9E130F0EC3827FC3CCC9C&name=Homepage%20Widget&folder=17792

    Response
    <opens-api>
      <status>OK</status>
    </opens-api>
  3. Customizing the widget.

    The widget API has controls to define the layout, the number of headlines, the read story behavior, etc., as well as, CSS styles for adjusting the text font, font-size, colors, etc. See the Widget APIs, e.g. widget/update, widget/updatestyle, etc., to learn about all the options available to customize how the headlines and stories are displayed on your page.

  4. Placing widget headlines on your page.

    Depending on whether the widget is of the type IFRAME or PROXY, use the following integration instructions:

    If widget is set to type IFRAME, use the following integration instructions:

    Before the <HTML> element, at the very top of the page add: 
    <!DOCTYPE html>

    In the <HEAD> element, add:
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />

    Paste the following <iframe> into the body where headlines are needed:
    <iframe src="https://secure.newsedge.com/neif/<<widget-id>>.html?refreshMinutes=0"></iframe>

    If widget is set to type PROXY, use the following integration instructions:

    On your webserver, create a proxy pass and reverse proxy pass from /nenp/ and https://secure.newsedge.com/nenp/ 

    Before the <HTML> element, at the very top of the page add:
    <!DOCTYPE html>

    In the <HEAD> element, add:
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    <link rel="stylesheet" href="/nenp/<<widget-id>>.css" media="screen" />
    <script type="text/javascript" src="/nenp/<<widget-id>>.js"></script>
    In the <BODY> element, add: 
    <body onload="ne_win_init(0);">

    Paste the following <DIV> into the body where headlines are needed:
    <div id="newspipe_<<widget-id>>"></div>

    Integrating the widget HTML code to your page is a one-time set up. If the widget formatting is modified using widget/update or widget/updatestyle, you are not required to update the HTML code as it will be unchanged.

storyfolder/create - Create a folder for storing stories

Use storyfolder/create to create a folder for storing stories selected from results returned by the news/search request. See also api/info where noun=storyfolder and verb=create.

See storyfolder/update for how to save stories automatically from a saved search in a story folder.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/create?session=<<user-token>>&name=<<folder-name>>[&parameter=value][& . . .]

Required Parameters

Parameter Values Description
nameA name for the created folder.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.
activeDelayDefault:-1
-1, 0, 1, 2, ..., expiry value
The number of days before the system automatically changes a story's status from ACTIVE to STORED.

-1 - The status of stories is never changed automatically from ACTIVE to STORED.

0 - The status of stories is changed immediately to STORED when the story is added.

1, 2, ..., up to expiry value - The number of days before stories are automatically changed to STORED. A story's day begins with the dateAdded value when it is added to the folder. The maximum value is equal to or less than expiry value.

descriptionAdds a description to the story folder.
expiryDefault:90
1-180
The number of days from when a story is added to when it is automatically deleted from the folder. The maximum number of days the system keeps a story in a folder is 180 days. However, your specific user expiry maximum might be lower.
manageabilityDefault:NONE
NONE, SIDEWAYS, UP

Sets who can manage the folder and its contents, i.e. changing the folder options, its name or description, as well as, rights to manage the stories including change order of stories, modify story status, or delete stories in the folder.

NONE - The folder can only be managed by the current user only.

SIDEWAYS - The folder can be managed by the current user and other members of the same group.

UP - The folder can be managed by the current user and other users of the same account.

See also sharing and writeability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

pendingDelayDefault:0
-1, 0, 1, 2, ..., expiry value
The number of days after which the system will reset the status of a story from PENDING to ACTIVE.

-1 - The system will not automatically reset the status of PENDING stories to ACTIVE.

0 - If a PENDING story is added to the folder, the system will immediately reset its status to ACTIVE.

1, 2, ..., up to expiry value - The number of days from when a PENDING story is added to the folder, to when the system will automatically reset its status to ACTIVE. The maximum value is equal to or less than expiry value.

sharingDefault:NONE
NONE, SIDEWAYS, UP
Sets who can read the stories in the folder.

NONE - The folder can only be read by the current user.

SIDEWAYS - The folder can be read by the current user and other members of the same group.

UP - The folder can be read by the current user and other users of the same account.

See also writeability and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

sortDefault:RANK
DATEADDED, PUBDATE, RANK, RECEIVEDATE
Defines the order stories are listed in the returned results.

DATEADDED - Order stories by the date and time the story was added to the folder.

PUBDATE - Order stories by the date and time the story was published.

RANK - Order stories by the story order value.

RECEIVEDATE - Order stories by the date and time the story was received by Acquire Media.

writeabilityDefault:NONE
NONE, SIDEWAYS, UP
Sets who can add stories to the folder.

NONE - The folder can only be written to by the current user.

SIDEWAYS - The folder can be written to by the current user and other members of the same group.

UP - The folder can be written to by the current user and other users of the same account.

See also sharing and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.


Returned Results

The returned results are an opens-api element with a status sub-element and page sub-element that identifies the created story folder.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.

storyfolderThe storyfolder element represents the created folder and contains the following attributes:

id - The story folder identifier to use in other API requests.

name - The name of the folder, which is the same value entered for the name parameter in the storyfolder/create request.


storyfolder/list - Get a list of story folders

Use storyfolder/list to get a list of story folders. See also api/info where noun=storyfolder and verb=list.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/list?session=<<user-token>>[&level=<<level>>]

Required Parameters

Parameter Values Description
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.
levelDefault:ACCOUNT
USER, GROUP, ACCOUNT
Display the folders for the specified level.
  • USER - Show folders created by the current user with the storyfolder/create API.
  • GROUP - Show folders created by the current user and folders created by members of the user's group with sharing set to SIDEWAYS.
  • ACCOUNT - Show folders created by the current user, folders created by members of the user's group with sharing set to SIDEWAYS, and folders created by other users in the same account where the folder is set with sharing set to UP.

Returned Results

The returned results are an opens-api element that includes a status sub-element and a storyfolders sub-element representing the list of story folders.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.

storyfoldersThe storyfolders element represents the list of story folders where each folder is represented by a storyfolder sub-element. The storyfolders element includes a count attribute representing the number of storyfolder sub-elements.

storyfolders

Name Values Description
storyfolderThe storyfolder element represents a folder and contains the following attributes:

id - The story folder identifier to use in other API requests.

count - The number of stories contained in the folder.

sharing - Indicates who can read, write or manage the stories in the folder. Valid values are: NONE (current user), SIDEWAYS (current user and others of the same group), UP (current user and others of the same organization). The default is NONE.

name - The name of the story folder.

description - A description of the story folder.

owner - The owner of the story folder.

level - The level of the folder is calculated by OPENS and indicates who owns the folder. Valid values are USER (current user), GROUP (current user and others in the same group), ACCOUNT (current user and others in the same organization). The default value is USER.

permission - The folder permission settings for the current user. The permission will show one or more values separated by the pipe (|) character. Valid values are: READ means you can view stories in the folder. WRITE means you can add stories to the folder. MANAGE means you can modify the folder settings.

sort - Indicates the order in which story elements are listed in the folder. Valid values are DATEADDED (from newest to oldest), PUBDATE (from newest to oldest publication date), RANK (by story's order attribute from highest to lowest), RECEIVEDATE (from newest to oldest). The default value is RANK.


storyfolder/info - List story folder information

Use storyfolder/info to get details about a story folder. See also api/info where noun=storyfolder and verb=info.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/info?session=<<user-token>>&folder=<<folder-ID>>[&parameter=value][& . . .]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Returned Results

The returned results are an opens-api element that represents the story folder with status and storyfolder sub-elements.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error. Review api/info for parameter list.

storyfolderThe storyfolder element contains child sub-elements representing the folder and has the following attributes:

id - The story folder identifier to use in other API requests.

owner - The owner of the story folder.

name - The name of the story folder.

permission - The folder permission settings for the current user. The permission will show one or more values separated by the pipe (|) character. Valid values are: READ means you can view stories in the folder. WRITE means you can add stories to the folder. MANAGE means you can modify the folder settings.

autofillSearchId - The id referencing the saved search used to autofill the story folder. If the value is empty or the autofillDepth=0, the folder does not use a saved search to get stories.

autofillSearchName - If the autofillSearchId attribute identifies a saved search, this identifies the saved search name.

autofillMode - If the autofillSearchId attribute identifies a saved search, this attribute identifies the mode the system uses to add stories. Valid values are automatic and manual.

autofillDepth - If the autofillSearchId attribute identifies a saved search, this identifies the minimum number of active stories in the folder. When the minimum number is met, the folder will not be autofilled. When the number of active stories is fewer than the minimum number, autofill will retrieve stories to complete the difference between active stories and minimum number of stories. Note, a value of 0 disables the autofill mechanism for the folder.

autofillCount - The number of stories added to the story folder by the autofill action and these stories are displayed with status as AUTOFILLED.

count - The number of stories contained in the folder.


storyfolder

Name Values Description
active-delay-1, 0, 1, 2, ..., expiry valueControls when the system will reset the status of a story from ACTIVE to STORED.

-1 - The system will not automatically reset the status from ACTIVE to STORED. This is the default value.

0 - When an ACTIVE story is added to the folder, the system will immediately reset its status to STORED.

1, 2, ..., up to expiry value - The number of days from when an ACTIVE story is added to the folder to when the system will automatically reset its status to STORED.

autofillActiveDelay0, 1, . . .The amount of time in minutes that an autofill story remains in ACTIVE status before the system automatically resets the story to the STORED status. The time begins when an ACTIVE story is added to the folder. See the story element's dateAdded time.
descriptionA description of the story folder.
expiry1, . . . user-expiry-maximumThe number of days from when a story is added to when the system automatically deletes it from the folder. If this value is not set, the maximum number of days is 180. However, your specific user expiry maximum might be lower.
manageabilityNONE, SIDEWAYS, UP

The manageability attribute indicates the MANAGE levels of the storyfolder permission attribute. i.e. who can change the folder options, its name or description, as well as, who has rights to manage the stories including change order of stories, modify story status, or delete stories in the folder.

NONE - The folder can only be managed by the current user.

SIDEWAYS - The folder can be managed by the current user and other members of the same group.

UP - The folder can be managed by the current user and other users of the same account.

See also sharing and writeability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

pending-delay-1, 0, 1, 2, ..., expiry-valueControls when the system will reset the status of a story from PENDING to ACTIVE.

-1 - The system will not automatically reset the status of PENDING stories to ACTIVE.

0 - When a PENDING story is added to the folder, the system will immediately reset its status to ACTIVE. This is the default value.

1, 2, ..., up to expiry value - The number of days to keep the story with status as PENDING. After this period, the system will reset the story status to ACTIVE.

sharingNONE, SIDEWAYS, UPIndicates who can read the stories. Valid values are:

NONE - The folder can only be maintained by the current user. This is the default value for sharing.

SIDEWAYS - The folder is accessible to the current user and other members of the same group.

UP - The folder is accessible to the current user and other users of the same account.

See also writeability and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

sortDATEADDED, PUBDATE, RANK, RECEIVEDATEIndicates the order in which story elements are listed in the folder.

DATEADDED - stories are ordered by the story element's dateAdded attribute from newest to oldest.

PUBDATE - stories are ordered by the story element's publicationDate attribute from newest to oldest.

RANK - stories are ordered by the story element's order attribute from highest to lowest.

RECEIVEDATE - stories are ordered by the story element's receivedDate attribute from newest to oldest.

writeabilityNONE, SIDEWAYS, UPIndicates who can add stories to the folder.

NONE - The folder can only be written to by the current user.

SIDEWAYS - The folder can be written to by the current user and other members of the same group.

UP - The folder can be written to by the current user and other users of the same account.

See also sharing and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.


storyfolder/update - Update a folder

Use storyfolder/update to modify the settings of a folder, from its name and description, to default settings for stories added to the folder. The storyfolder/update API is also used to link a saved search and other settings for the autofill function. See also api/info where noun=storyfolder and verb=update.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/update?session=<<user-token>>&folder=<<folder-ID>>[&parameter=value][& . . .]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
activeDelayDefault:-1
-1, 0, 1, 2, ..., expiry value
The number of days before the system automatically changes a story's status from ACTIVE to STORED.

-1 - The status of stories is never changed automatically from ACTIVE to STORED.

0 - The status of stories is changed immediately to STORED when the story is added.

1, 2, ..., up to expiry value - The number of days before stories are automatically changed to STORED. A story's day begins with the dateAdded value when it is added to the folder. The maximum value is equal to or less than expiry value.

descriptionAdds a description to the story folder.
expiryDefault:90
1-180
The number of days from when a story is added to when it is automatically deleted from the folder. The maximum number of days the system keeps a story in a folder is 180 days. However, your specific user expiry maximum might be lower.
manageabilityDefault:NONE
NONE, SIDEWAYS, UP

Sets who can manage the folder and its contents, i.e. changing the folder options, its name or description, as well as, rights to manage the stories including change order of stories, modify story status, or delete stories in the folder.

NONE - The folder can only be managed by the current user only.

SIDEWAYS - The folder can be managed by the current user and other members of the same group.

UP - The folder can be managed by the current user and other users of the same account.

See also sharing, writeability, and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

nameA name for the created folder.
pendingDelayDefault:0
-1, 0, 1, 2, ..., expiry value
The number of days after which the system will reset the status of a story from PENDING to ACTIVE.

-1 - The system will not automatically reset the status of PENDING stories to ACTIVE.

0 - If a PENDING story is added to the folder, the system will immediately reset its status to ACTIVE.

1, 2, ..., up to expiry value - The number of days from when a PENDING story is added to the folder, to when the system will automatically reset its status to ACTIVE. The maximum value is equal to or less than expiry value.

sharingDefault:NONE
NONE, SIDEWAYS, UP
Sets who can read the stories in the folder.

NONE - The folder can only be read by the current user.

SIDEWAYS - The folder can be read by the current user and other members of the same group.

UP - The folder can be read by the current user and other users of the same account.

See also writeability and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.

sortDefault:RANK
DATEADDED, PUBDATE, RANK, RECEIVEDATE
Defines the order stories are listed in the returned results.

DATEADDED - Order stories by the date and time the story was added to the folder.

PUBDATE - Order stories by the date and time the story was published.

RANK - Order stories by the story order value.

RECEIVEDATE - Order stories by the date and time the story was received by Acquire Media.

writeabilityDefault:NONE
NONE, SIDEWAYS, UP
Sets who can add stories to the folder.

NONE - The folder can only be written to by the current user.

SIDEWAYS - The folder can be written to by the current user and other members of the same group.

UP - The folder can be written to by the current user and other users of the same account.

See also sharing and manageability parameters, as all three affect the folder's permission levels READ, WRITE, and MANAGE.


Optional Parameters to Link a Saved Search to a Story Folder

Parameter Values Description
autofillActiveDelay15, 16, 17, etc.If the autofillSearchId attribute identifies a saved search, and the autofillMode is automatic, this parameter is required to define the number of minutes a story remains marked as ACTIVE before its status is updated to STORED. The minimum value for this parameter is 15 minutes.

autofillDepthDefault:0
0, 1, 2, ..., 100
If the autofillSearchId attribute identifies a saved search, this parameter is required to determine the minimum number of "active" stories to show in the story folder.

0 - a value of zero disables the Link a Saved Search feature.

autofillModeDefault:manual
automatic, manual
If the autofillSearchId attribute identifies a saved search, this parameter identifies the mode the system uses to add stories.

automatic - The story folder is automatically populated with stories from the linked saved search. When selected stories in the story folder change from "active" to "stored" based on the autofillActiveDelay period, the system will automatically execute the saved search and insert new stories to maintain the number of "active" stories defined by the autofillDepth value.

manual - The story folder is manually populated with stories from the saved search. The OPENS API user submits a request to "fill" the folder with search results from the linked saved search. The number of stories returned by the API is determined by the difference between the autofillDepth value and the number of "active" stories currently found in the folder. The OPENS API user must then decide the search results to keep or discard.

autofillSearchIdThe autofillSearchId is used to link a saved search to a story folder. Use the saved search Id returned by the savedsearch/list or savedsearch/info API request. When the autofillSearchId parameter is defined with the storyfolder/update, the autofillDepth parameter is required as well. When the autofillSearchId parameter is defined and autofillMode is automatic, both the autofillDepth and autofillActiveDelay are required. Use the storyfolder/info API with autofill parameter to execute the saved search and obtain stories for inclusion in the story folder.

Returned Results

The returned results are an opens-api element with a status sub-element and page sub-element that identifies the updated story folder.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.


storyfolder/addstory - Save a story in a story folder

Use storyfolder/addstory to save a story in a folder. Stories are obtained from the returned results of news/search. Note that stories are not saved in a folder indefinitely but automatically expire and are deleted. The default expiry timeframe is 180 days after the story is added. To change a folder's expiry timeframe, see the expiry parameter of storyfolder/update. See also api/info where noun=storyfolder and verb=addstory.

To add stories automatically from a saved search, see storyfolder/update.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/addstory?session=<<user-token>>&folder=<<folder-ID>>&story=<<story-key>>[&parameter=value][& . . .]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.
story

A key that identifies a story in news/search results or the storyfolder/info results after a request is made with the autofill parameter and a value 1. Use the value of the key that is within the storyURL element. For example:

<storyURL>https://secure.newsedge.com/opensapi/20/news/read? key=vh_-0vz32R8dBBLmN5a_G6lzwmwYr7zqfwqkNTAA6IbHsjisLdAJqWEQLXMxnNOvOLurXwofrfF _-nHZ7Ab4vqVC19-QLDET0m6QWKI6Rh2xR0zpBsueGHwmEiDviN9b</storyURL>

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.
statusDefault:PENDING
ACTIVE, PENDING, STORED

The status of the story in the folder. These values are case-sensitive.

ACTIVE - An active status is the normal setting for stories and means the story can be viewed.

PENDING - A pending status means the story is to be previewed. You can use the PENDING status if your application needs to preview stories.

STORED - A stored status means the story is archived because it is older. You would rarely add a story with an initial status of STORED.

See storyfolder/updatestory and storyfolder/update for more about status transitions and when the system automatically resets story status.


Returned Results

The returned results include an opens-api element that contains status and page sub-elements.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.

storyfolderThis represents the folder in which the story has been added. The value of its id attribute is the same value as the folder parameter of the storyfolder/addstory request.
storyThe story element contains the following attributes:

id - The story identifier to use to represent the story in storyfolder requests.

order - The order of the story in the folder if the folder's sort value is RANK.

status - The story's status in the folder. Valid values include ACTIVE, PENDING, STORED.

dateAdded - The date and time the story was added to the folder. Format of this date value is YYYYMMDDTHHMMSS-ZZZZ

publicationDate - The date and time the story was published.

receivedDate - The data and time the story was received by Acquire Media.

title - The title of the story.

summary - The summary text of the story.

thumbnail - A link to a thumbnail image if story has one. If thumbnail is not available, this attribute is not listed.

storyURL - The URL to the story. To read a story, use news/read.

storyGUID - A globally unique identifier of the story. You can use this value to compare stories in your set of story folders to determine if any saved stories are the same.

storyType - Describes whether the story is licensed or weblinked. Allowed values are: "licensed", "pub-source" which indicates a WebLinked story, and "associated media" which indicates the thumbnail attribute contains a value.

sourceName - The publication source of the story. See also source/search.

shortSourceName - The text that should be displayed to the user as the source of the story.

sourceCode - The Acquire Media code for the publication source. See also source/search.

storyIcon - If available, a reference to an image such as a vendor or source icon. If not available, this attribute is not listed

byline - The byline attribute lists the people and/or organizations that created the news asset, in a free-form, unstructured text.

copyright - The copyright attribute provides information about the intellectual property rights owner for the news asset, in a free-form, unstructured text.

wordcount - Word counts is only reported with a licensed story. If word count is not available, this attribute is not listed


storyfolder/updatestory - Update a story in your story folders

Use storyfolder/updatestory to modify the status or order of a story in the folder. See also api/info where noun=storyfolder and verb=updatestory.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/updatestory?session=<<user-token>>&folder=<<folder-ID>>&story=<<story-key>>[&parameter=value][&. . .]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.
storyThe story identifier. Use the value of the story id attribute returned from a storyfolder/addstory or storyfolder/info request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.
orderThe order parameter would be used to change the order value of a story which is used to determine the sorting of headlines in the folder. This value is only applicable when the story folder sort is set to RANK.
statusACTIVE, EXCLUDED, PENDING, STORED

Change the status for a story.

ACTIVE - Modify the story status to ACTIVE.

EXCLUDED - Set the story to EXCLUDED status. Applicable only when a saved search is linked to the folder and when autofillMode is manual. When the autofill request is made and a list of candidate stories presented, a story can be excluded from the folder and will not re-appear in subsequent autofill activities.

PENDING - Modify the story status to PENDING. PENDING stories can be items pending approval for inclusion in the folder.

STORED - Modify the story status to STORED. STORED stories can be considered as archived and will remain in the folder for the period defined by the story folder expiry period.


Returned Results

The returned results are an opens-api element with a status sub-element.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.


storyfolder/liststories - List stories in your folder

Use storyfolder/liststories to get a list of stories in a folder. When the folder is linked to a saved search and is configured for autofillMode as automatic, the storyfolder/liststories API also updates stories in the folder. However, if the autofillMode is manual, the storyfolder/liststories request requires the optional parameter autofill to retrieve candidate stories, followed by the storyfolder/addstory API with the status parameter to add or exclude a story.

See also api/info where noun=storyfolder and verb=liststories.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/liststories?session=<<user-token>>&folder=<<folder-ID>>[&parameter=value][& . . .]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.
pageDefault:1
1, 2, . . . total-Pages
A number representing a page of returned results. Use the page parameter in subsequent storyfolder/liststories requests to return another page of results showing more story elements. For example, add &page=2 to a request to return the second page of results.
resultsPerPageDefault:20
1, 2, . . . 210
The number of story elements returned per page.
sortDefault:RANK
RANK, DATEADDED, RECEIVEDATE, PUBDATE

The method to sort the stories in the returned results. Note using this parameter with the storyfolder/liststories API applies only to the current returned result set. To update the default sort order for this folder, submit a storyfolder/update API request with the parameter sort and the desired default sorting value.

RANK - Sort the stories by the story element's order attribute from highest to lowest.

DATEADDED - Sort the stories from newest to oldest by the story element's dateAdded attribute, which is the date and time the story was added to the folder.

RECEIVEDATE - Sort the stories from newest to oldest by the story element's receivedDate attribute, which is the date and time the story was received by Acquire Media.

PUBDATE - Sort the stories from newest to oldest by the story element's publicationDate attribute, which is the date and time the story was published.

statusDefault:ALL
ALL, ACTIVE, AUTOFILLED, EXCLUDED, PENDING, STORED

Show the stories that have this status value.

ALL - Show all stories with a status of either ACTIVE, AUTOFILLED, PENDING, or STORED. Do not show stories with status as EXCLUDED.

ACTIVE - Show only stories with ACTIVE status.

AUTOFILLED - Show only stories added to the folder using the autofill action. Applicable only when using the optional parameter autofill and autofillMode is manual with a saved search is linked to the folder.

EXCLUDED - Show only stories with EXCLUDED status. Applicable only when autofillMode is manual and a saved search is linked to the folder.

PENDING - Show only stories with PENDING status.

STORED - Show only stories with STORED status. STORED stories can be considered as archived and will remain in the folder for the period defined by the story folder expiry period.


Optional Parameters to Fill a Story Folder linked to a Saved Search

Parameter Values Description
autofillDefault:0
0, 1

The autofill parameter automatically populates the folder with stories using a saved search. See storyfolder/update for more information about configuring the autofill settings for the folder.

0 - the folder is not auto filled using a saved search.

1 - the folder is set to autofill using a saved search.

limit1, 2, . . ., 100The maximum number of stories to return when using the autofill parameter.

Returned Results

The returned results are an opens-api element that represents the story folder with status and storyfolder sub-elements.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error. Review api/info for parameter list.

storyfolder

The storyfolder element contains child sub-elements representing the folder and has the following attributes:

sort - Indicates the order in which story elements are listed in the folder. Allowed values are: DATEADDED, PUBDATE, RANK, and RECEIVEDATE.

autofillActiveDelay - The amount of time in minutes that an autofill story remains in ACTIVE status before the system automatically resets the story to the STORED status. The time begins when an ACTIVE story is added to the folder. See the story element's dateAdded time.

id - The story folder identifier to use in other API requests.

owner - The owner of the story folder.

name - The name of the story folder.

autofillSearchId - The id referencing the saved search used to autofill the story folder. If the value is empty or the autofillDepth=0, the folder does not use a saved search to get stories.

autofillSearchName - If the autofillSearchId attribute identifies a saved search, this identifies the saved search name.

autofillMode - If the autofillSearchId attribute identifies a saved search, this attribute identifies the mode the system uses to add stories. Valid values are automatic and manual. The default is manual.

autofillDepth - If the autofillSearchId attribute identifies a saved search, this identifies the minimum number of active stories in the folder. When the minimum number is met, the folder will not be autofilled. When the number of stories with status as active is fewer than the minimum number, autofill will retrieve stories to complete the difference between active stories and minimum number of stories. Note, a value of 0 disables the autofill mechanism for the folder.

autofillCount - The number of stories added to the story folder by the autofill action where these stories are displayed with status as AUTOFILLED.

count - The number of stories, with either active, pending, stored or autofilled status, contained in the folder.


storyfolder

Name Values Description
story

The story element represents a story in the folder and has the following attributes:

id - The story identifier to use to represent the story in storyfolder requests. Note: The "id" attribute has not yet been assigned when the story has status "AUTOFILLED".

order - The order of the story in the folder if the folder's sort value is RANK.

status - The story's status in the folder. Valid values include ACTIVE, AUTOFILLED, PENDING, STORED, or EXCLUDED.

dateAdded - The date and time the story was added to the folder.

publicationDate - The date and time the story was published.

receivedDate - The data and time the story was received by Acquire Media.

title - The title of the story.

summary - The summary text of the story.

thumbnail - A link to a thumbnail image if story has one. If thumbnail is not available, this attribute is not listed.

storyURL - The URL to the story. To read a story, use news/read.

storyGUID - A globally unique identifier of the story. You can use this value to compare stories in the story folder.

storyType - Describes whether the story is licensed or weblinked. Allowed values are: licensed, pub-source (which indicates a WebLinked story), and associated media (which indicates the thumbnail attribute contains a value).

sourceName - The Acquire Media full name for the publication.

shortSourceName - The text that should be displayed to the user as the source of the story.

sourceCode - The Acquire Media code for the publication source.

storyIcon - If available, a reference to an image such as a vendor or source icon. If not available, this attribute is not listed

byline - The byline attribute lists the people and/or organizations that created the news asset, in a free-form, unstructured text.

copyright - The copyright attribute provides information about the intellectual property rights owner for the news asset, in a free-form, unstructured text.

wordcount - Word count is only reported with a licensed story. If word count is not available, this attribute is not listed


storyfolder/deletestory - Delete a story from a story folder

Use storyfolder/deletestory to permanently delete a story from a story folder. See also api/info where noun=storyfolder and verb=deletestory. To manually add a story, see storyfolder/addstory.

Note, when the folder is autofilled by a saved search, do not delete a story with AUTOFILLED status. Instead, reset the story status to EXCLUDED using storyfolder/updatestory and this will prevent the same story from reappearing the next time the saved search is executed as the folder is autofilled.

Stories are not saved in a folder indefinitely but automatically expire and are deleted. The default expiry timeframe is 90 days after the story is added. To change a folder's expiry timeframe, see the expiry parameter of storyfolder/update.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/deletestory?session=<<user-token>>&folder=<<folder-ID>>&story=<<story-ID>>[&parameter=value]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.
storyThe story identifier. Use the value of the story id attribute returned from a storyfolder/addstory or storyfolder/info request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Returned Results

The returned results are an opens-api element with a status sub-element.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.


storyfolder/delete - Delete a previously created story folder

Use storyfolder/delete to delete a story folder and any stories it contains. To delete individual stories from a folder, use storyfolder/deletestory. See also api/info where noun=storyfolder and verb=delete.


Example

https://secure.newsedge.com/opensapi/20/storyfolder/delete?session=<<user-token>>&folder=<<folder-ID>>[&parameter=value]

Required Parameters

Parameter Values Description
folderThe story folder identifier. Use the value of the storyfolder id attribute returned from a storyfolder/create, storyfolder/info, or storyfolder/list request.
sessionThe ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter Values Description
jsonDefault:0
0,1,2
The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.
  • 0 - Return data in XML format.
  • 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
  • 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Returned Results

The returned results are an opens-api element with a status sub-element.

opens-api

Name Values Description
statusOK, ERROR

The status of the request.

OK - Request completed successfully.

ERROR - An error occurred with the request. An error element contains a description of the error.