API Definition

Displaying Stories

Reading Stories
Highlighting Query Terms in Stories
Formatting Stories as PDF or RTF

Reading Stories
Reading Stories from news/search

This example reuses the search we did in "Searching for Company News" where we used metadata to search for stories about General Electric. A results list is returned that contains stories represented by multiple result elements. Each result element includes a storyURL sub-element that you use to get the story content.

  1. Get stories from news/search results.

    Request
    https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query=[com:/acorn=1655421979].use=primary
    				

    Response
    <searchResults searchKey="112130_20160305T143230253">
      <search startDate="20160205T000000-0500" endDate="20160305T143330-0500" resultsPerPage="20" stem="1" summary="0" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="1" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" picksOnly="false" highlight="false" expiredStories="both" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">...</search>
      <pageInfo>...</pageInfo>
      <results status="true">
        <result score="0.829998" docId="147435" docIndex="1" pick="false">...</result>
        <result score="0.33540973" docId="145427" docIndex="2" pick="false">...</result>
        <result score="0.36962616" docId="137061" docIndex="3" pick="false">
          <id>RTGrmh3SN9SoAmxsTDeEEch2igcoY6i3PZmgOzzZnDVcefFjs2UM9XO_p4_4NOlQ</id>
          <storyURL>https://secure.newsedge.com/opensapi/20/news/read?key=B-nbb3LqS__l8FJtHkoQuVAoOBDgNCikK8zp3JI3d4q5_GQi9HHBrQMasQrSx6p-Ofl0HTCkyC8BaXy4TB7LWfOwoXJHEh-XeRghdylsA4_UgXa9LMHDy9ZZKhYEYYjLK93EsQfir8G8sdn0RwyYmg**
    </storyURL>
          <type code="News"/>
          <publication-date>20160304T000100-0500</publication-date>
          <received-date>20160304T000100-0500</received-date>
          <source code="TNS_Tenders" name="Targeted News Service (Tenders)" short-name="Targeted News Service (Tenders)">
            <provider code="TNS_____" name="Targeted News Service">
              <service code="TNS" name="News Service"/>
            </provider>
          </source>
          <packages>
            <package code="OCS"/>
            <package code="NewsEdge"/>
            <package code="CCS"/>
          </packages>
          <headline>
            MILITARY $62,591 Federal Contract Awarded to G.E. Aviation
          </headline>
          <cluster cluster-publication-date="20160304T000100-0500" cluster-received-date="20160304T000100-0500">...</cluster>
        </result>
        <result score="0.23213395" docId="119450" docIndex="4" pick="false">...</result>
        <result score="0.5527005" docId="118666" docIndex="5" pick="false">...</result>
        <result score="0.8298062" docId="113093" docIndex="6" pick="false">...</result>
        <result score="0.32372436" docId="112964" docIndex="7" pick="false">...</result>
        <result score="0.22171177" docId="102091" docIndex="8" pick="false">...</result>
        <result score="0.23234707" docId="110223" docIndex="9" pick="false">...</result>
        <result score="0.55280703" docId="104626" docIndex="10" pick="false">...</result>
        <result score="0.55280703" docId="104633" docIndex="11" pick="false">...</result>
        <result score="0.55280703" docId="104647" docIndex="12" pick="false">...</result>
        <result score="0.55280703" docId="104658" docIndex="13" pick="false">...</result>
        <result score="0.55280703" docId="104674" docIndex="14" pick="false">...</result>
        <result score="0.55280703" docId="104691" docIndex="15" pick="false">...</result>
        <result score="0.55280703" docId="104692" docIndex="16" pick="false">...</result>
        <result score="0.55280703" docId="104701" docIndex="17" pick="false">...</result>
        <result score="0.55280703" docId="104724" docIndex="18" pick="false">...</result>
        <result score="0.55280703" docId="104727" docIndex="19" pick="false">...</result>
        <result score="0.55280703" docId="104785" docIndex="20" pick="false">...</result>
      </results>
    </searchResults>
    				
  2. Submit a news/read with the storyURL.
     <headline> MILITARY $62,591 Federal Contract Awarded to G.E. Aviation </headline> 

    Returned results are XML whose format depends on your agreement with Acquire Media. The results here show an abbreviated example of Acquire Media's Simple News in XML format, also known as SNiX.


    Request
    https://secure.newsedge.com/opensapi/20/news/read?key=W9QH4DOdNZLUojJ9_5SlV-jBpgQtcch8QzHR4uost3YcF-O21aYApOi8YbwyF02OlJfKgoHVgF9EmLNY1VkKR-iK7HZJq_YJF8elvmMvENj45_IzFGhOX31594vvlrHEgNtfPPYFuHNPviMUEBir-w**
    				

    Response
    <newsedge version="1.0">
      <header>...</header>
      <asset>
        <newslines>
          <headline>
            MILITARY $963,513 Federal Contract Awarded to G.E. Aviation
          </headline>
          <copyrightline>(c) 2016 Targeted News Service</copyrightline>
          <summary>
            By Targeted News Service WASHINGTON, March 4 -- General Electric Co. dba G.E. Aviation, Lynn, Massachusetts, won a $963,512.88 federal contract from the Defense Logistics Agency, Richmond, Virginia, for aircraft gas turbine engine turbine cases. For more information about Targeted News Service's products, including its daily federal contract report, please contact: Myron Struck, ...
          </summary>
        </newslines>
        <content>
          <block>
            <p>
              By
              <org>Targeted News Service</org>
            </p>
            <p>
              <location idsrc="xmltag.org" value="LU/us.dc.wash">WASHINGTON</location>
              ,
              <chron>March 4</chron>
              --
              <org idsrc="xmltag.org" value="NYSE:GE">General Electric Co.</org>
              dba
              <org>G.E. Aviation</org>
              ,
              <location idsrc="xmltag.org" value="LU/us.ma.lynn">Lynn, Massachusetts</location>
              , won a
              <money>$963,512.88</money>
              federal contract from the
              <org idsrc="xmltag.org" value="ACORN:0588221060">Defense Logistics Agency</org>
              ,
              <location idsrc="xmltag.org" value="LU/us.va.rchmnd">Richmond, Virginia</location>
              , for aircraft gas turbine engine turbine cases.
            </p>
            <p>
              For more information about
              <org>Targeted News Service's</org>
              products, including its daily federal contract report, please contact:
              <person>Myron Struck</person>
              ,
              <a href="mailto:Myron@targetednews.com">Myron@targetednews.com</a>
              , Editor,
              <org>Targeted News Service LLC</org>
              ,
              <location idsrc="xmltag.org" value="LU/us.va.sprgfd">Springfield, Va.</location>
              , Direct: 703/866-4708, Cell: 703/304-1897.
            </p>
            <p>22DayandanteA 160304-889525 30VitinMar</p>
          </block>
        </content>
        <language code="en"/>
        <dup-check>B94D35</dup-check>
      </asset>
    </newsedge>
    				
  3. Use story metadata from the header results.
    This request uses the same storyURL as in the previous step, but in these results we show the header element details, which contain metadata fields related to the story. For example, the header element's id sub-element identifies a specific story from a search results. You can use this id element in your application to manage which stories have been read by the user.

    Request
    https://secure.newsedge.com/opensapi/20/news/read?key=W9QH4DOdNZLUojJ9_5SlV-jBpgQtcch8QzHR4uost3YcF-O21aYApOi8YbwyF02OlJfKgoHVgF9EmLNY1VkKR-iK7HZJq_YJF8elvmMvENj45_IzFGhOX31594vvlrHEgNtfPPYFuHNPviMUEBir-w**
    				

    Response
    <newsedge version="1.0">
      <header>
        <id>RTGrmh3SN9SoAmxsTDeEEch2igcoY6i3PZmgOzzZnDV-tQ7e6LF-P5OV74NpAQxm</id>
        <storyURL>https://secure.newsedge.com/servlet/StoryRetrieval/GetStory?key=W9QH4DOdNZLUojJ9_5SlV-jBpgQtcch8QzHR4uost3YcF-O21aYApOi8YbwyF02OlJfKgoHVgF9EmLNY1VkKR-iK7HZJq_YJF8elvmMvENj45_IzFGhOX31594vvlrHEgNtfPPYFuHNPviMUEBir-w**</storyURL>
        <publish-reason code="original"/>
        <type code="News"/>
        <business-relevance>90</business-relevance>
        <dup>0</dup>
        <wordcount>77</wordcount>
        <publication-date>20160304T000100-0500</publication-date>
        <user-display-publication-date isotimevalue="2016-03-04T05:01:00Z">Friday, March 4, 2016</user-display-publication-date>
        <received-date>20160304T000100-0500</received-date>
        <user-display-received-date isotimevalue="2016-03-04T05:01:00Z">Friday, March 4, 2016, 12:01:00 AM EST</user-display-received-date>
        <lastchanged-date>20160304T074715-0500</lastchanged-date>
        <classification>...</classification>
        <source short-name="Targeted News Service (Tenders)" name="Targeted News Service (Tenders)" code="TNS_Tenders">...</source>
        <packages>...</packages>
      </header>
      <asset>...</asset>
    </newsedge>
    				
  4. View the story content in a browser.
    Spider stories will include a reference element with the attribute and value type="pub-source". The reference element will contain an item sub-element, which includes a URL to the story in an href attribute. Your application needs to submit this URL in the browser to display the story for a user.

    Request
    https://secure.newsedge.com/opensapi/20/news/read?key=E3LoSs26gGfmwT-m5GtQyxAPpoZI3RkolXIl1XFpQfF2ry5phZ4iJKxNFc7hrszK681QKhR80zb8hV1GefIaAdtgPtphTmSQOn2xEJe0NxQss_lAVcs1-zuG5SJ3Csk3UfNB0VBm4J-X1OzFgElI0iN5-f3FwZWZVBcL3tanEoo*

    Response
    <newsedge version="1.0">
      <header>
        <id>nhtTJ0odgMGuKJGhd6BM87V1oKDd0k1p1_5YjDfExnNywjgQd8zUqJK2037Q_WRCBU1aKOxPwMwdILRPn3F7p4Mrfqf3NwlkOOoEK5g6C8g*</id>
        <storyURL>https://secure.newsedge.com/servlet/StoryRetrieval/GetStory?key=E3LoSs26gGfmwT-m5GtQyxAPpoZI3RkolXIl1XFpQfF2ry5phZ4iJKxNFc7hrszK681QKhR80zb8hV1GefIaAdtgPtphTmSQOn2xEJe0NxQss_lAVcs1-zuG5SJ3Csk3UfNB0VBm4J-X1OzFgElI0iN5-f3FwZWZVBcL3tanEoo*</storyURL>
        <publish-reason code="original"/>
        <type code="Spider"/>
        <business-relevance>70
        </business-relevance>
        <dup>0</dup>
        <wordcount/>
        <publication-date>20160414T114400-0400</publication-date>
        <user-display-publication-date isotimevalue="2016-04-14T15:44:00Z">Thursday, April 14, 2016, 11:44:00 AM EDT</user-display-publication-date>
        <received-date>20160414T114400-0400</received-date>
        <user-display-received-date isotimevalue="2016-04-14T15:44:00Z">Thursday, April 14, 2016, 11:44:00 AM EDT</user-display-received-date>
        <lastchanged-date>20160414T114423-0400</lastchanged-date>
        <classification>...</classification>
        <source short-name="L'Express" name="L'Express (France) (French)" code="SPD_lexpress">...</source>
        <packages>...</packages>
        <references>
          <reference type="pub-source">
            <item href="http://lexpansion.lexpress.fr/actualites/1/actualite-economique/etats-unis-les-grandes-firmes-ont-depose-1-400-milliards-de-dollars-dans-des-paradis-fiscaux-selon-une-ong_1782832.html"/>
          </reference>
        </references>
      </header>
      <asset>...</asset>
    </newsedge>
            

Highlighting Query Terms in Stories
This example shows how to highlight query terms in the headline and summary elements of the news/search results and how to highlight terms in the story asset element, in particular, the headline and content sub-elements.
  1. Get search results with news/search.
    Use news/search to query for news tagged with the ACME subject code for Wind Energy adding the parameter highlight to view highlighted terms in the headline and summary elements.

    Request
    https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query=[SUBC:is/lifesoc.wind]&highlight=1&summary=1

    Response
    <searchResults searchKey="112130_20160422T083214940">
      <search startDate="20160322T000000-0400" endDate="20160422T083314-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="1" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="true" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg=""   <queryString>([SUBC:is/lifesoc.wind])</queryString>
      </search>
      <highlightTerms str="subCodeHighlight=is%2Flifesoc.wind"><highlight/>
        <comCodeHighlight/>
        <comHighlight/>
        <peoCodeHighlight/>
        <geoCodeHighlight/>
        <indCodeHighlight/>
        <subCodeHighlight>is/lifesoc.wind</subCodeHighlight>
      </highlightTerms>
      <pageInfo>...</pageInfo>
      <results status="true">
        <result score="0.362842">...</result>
        <result score="0.644145">...</result>
        <result score="0.12188035">...</result>
        <result score="0.16778927">...</result>
        <result score="0.24413425">...</result>
        <result score="0.42186773">...</result>
        <result score="0.0748136">...</result>
        <result score="0.12188035">...</result>
        <result score="0.15409897">
          <id>...</id>
          <storyURL>...</storyURL>
          <type code="News"/>
          <publication-date>20160414T121900-0400</publication-date>
          <received-date>20160414T121900-0400</received-date>
          <source code="ADP_Renewable_En" name="SeeNews Renewables" short-name="SeeNews Renewables">...</source>
          <packages>...</packages>
          <headline>Natural Power to help Kite Power Solutions with consenting Scottish test site</headline>
          <summary>
            April 14 (SeeNews) - Natural Power will help Kite Power Solutions (KPS), a kite 
            <label class="highlight">wind</label>
            <label class="highlight">energy</label> 
            technology developer, with the securing of consent for a test and development site at RAF West Freugh in Scotland.The renewable energy consultancy said yesterday it has been hired by KPS to support the project.The first KPS kite system is expected to start flying at RAF West Freugh, a Royal Air Force ...
          </summary>
        </result>
        <result score="0.24005954">...</result>
        <result score="1.0">...</result>
        <result score="0.3268249">...</result>
        <result score="0.41648436">...</result>
        <result score="0.43210715">...</result>
        <result score="0.644145">...</result>
        <result score="0.12508233">...</result>
        <result score="0.12508233">...</result>
        <result score="0.25410283">...</result>
        <result score="0.4324353">...</result>
        <result score="0.74999994">...</result>
      </results>
    </searchResults>
            
  2. Display story with highlighted terms.
    From the results returned in the previous step, use the storyUrl and the news/read api to retrieve the story, while appending the highlightTerms element string value to indicate query terms to be marked up in the story display.

    Request
    https://secure.newsedge.com/opensapi/20/news/read?key=XytIhK0Xays_eOpEyp7K8EmrhsOC0CYXERJU4yoTFeJ20pH635hDotm2QZv-N1ULVowPZoA6EQK7sOwjty25_e_fd82VMEcxczKUS2PdYOB0icAZKWOnhwx09uNw0q1M&subCodeHighlight=is%2Flifesoc.wind

    Response
    <newsedge version="1.0">
      <header>
        <id>...</id><storyURL>https://secure.newsedge.com/servlet/StoryRetrieval/GetStory?key=XytIhK0Xays_eOpEyp7K8EmrhsOC0CYXERJU4yoTFeJ20pH635hDotm2QZv-N1ULVowPZoA6EQK7sOwjty25_e_fd82VMEcxczKUS2PdYOB0icAZKWOnhwx09uNw0q1M</storyURL>
        <publish-reason code="original"/>
        <type code="News"/>
        <business-relevance>70</business-relevance>
        <dup>0</dup>
        <wordcount>218</wordcount>
        <publication-date>20160414T121900-0400</publication-date>
        <user-display-publication-date isotimevalue="2016-04-14T16:19:00Z">Thursday, April 14, 2016, 12:19:00 PM EDT</user-display-publication-date>
        <received-date>20160414T121900-0400</received-date>
        <user-display-received-date isotimevalue="2016-04-14T16:19:00Z">Thursday, April 14, 2016, 12:19:00 PM EDT</user-display-received-date>
        <lastchanged-date>20160414T112212-0400</lastchanged-date>
        <classification>...</classification>
        <source short-name="SeeNews Renewables" name="SeeNews Renewables" code="ADP_Renewable_En">...</source>
        <packages>...</packages>
      </header>
      <asset>
        <newslines>
          <headline>Natural Power to help Kite Power Solutions with consenting Scottish test site</headline>
          <copyrightline>Copyright 2016 SeeNews. All rights reserved.</copyrightline>
          <summary>April 14 (SeeNews) - Natural Power will help Kite Power Solutions (KPS), a kite 
            <label class="highlight">wind energy</label>
            technology developer, with the securing of consent for a test and development site at RAF West Freugh in Scotland.The renewable energy consultancy said yesterday it has been hired by KPS to support the project.The first KPS kite system is expected to start flying at RAF West Freugh, a Royal Air Force ...
          </summary>
        </newslines>
        <content>
        <p>
          <chron>April 14</chron>
          (SeeNews) - 
          <org>Natural Power</org>
          will help Kite Power Solutions (KPS), a kite 
          <label class="highlight">wind energy</label>
          technology developer, with the securing of consent for a test and development site at RAF West Freugh in 
          <location idsrc="xmltag.org" value="LS/gb.sco">Scotland</location>.
        </p>
        <p>...</p>
        <p>...</p>
        <p>...</p>
        <p>...</p>
        <p>...</p>
        <p>...</p>
        </content>
        <language code="en"/>
        <dup-check>18C71AC</dup-check>
      </asset>
    </newsedge>
            

Formatting Stories as PDF or RTF
See earlier examples about reading stories from news/search for how to get the storyURL element which contains the key parameter for accessing story content.
  1. Get the story's URL key.
    This example does a news/search to display a set of stories.

    Request
    https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query="Microsoft Apps"
    

    Response
    <searchResults searchKey="112130_20160306T145657975">
      <search startDate="20160206T000000-0500" endDate="20160306T145757-0500" resultsPerPage="20" stem="1" summary="0" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="1" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" picksOnly="false" highlight="false" expiredStories="both" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
        <queryString>("Microsoft Apps")</queryString>
      </search>
      <pageInfo>...</pageInfo>
      <results status="true">
        <result score="0.0030121799" docId="492307" docIndex="1" pick="false">...</result>
        <result score="0.006036526" docId="396531" docIndex="2" pick="false">...</result>
        <result score="0.0064402306" docId="366593" docIndex="3" pick="false">...</result>
        <result score="0.004410415" docId="350975" docIndex="4" pick="false">...</result>
        <result score="0.0066511286" docId="345319" docIndex="5" pick="false">...</result>
        <result score="1.0" docId="360356" docIndex="6" pick="true">...</result>
        <result score="0.0073094093" docId="356356" docIndex="7" pick="false">
          <id>
            8vHN-bPsz7O2IEtgDgDcxdjAdG9pDu1OD_1r6q78FQSD1NzS6BJ_qz1lT5NiovgD
          </id>
          <storyURL> 
            https://secure.newsedge.com/opensapi/20/news/read?key=Z7w4OpsnuNtXuWj2NfbgL8eCt5qBX2SZlKmEXvq9rSUiNWDIKYEU6SJDUeGoc523QgHNI4n8D6DYVL8cAm-bX2XmVtKxZqb2B5mjZ3sAxOxRKfJD5wHP8Uyu_09hpqAu
          </storyURL>
          <type code="News"/>
          <publication-date>20160211T000100-0500</publication-date>
          <received-date>20160211T000100-0500</received-date>
          <source code="Information_Week" name="Information Week" short-name="Information Week">
            <provider code="CMP_____" name="CMP Media LLC.">
              <service code="Ent+Comp_Channel" name="Enterprise & Personal Computing News Package"/>
            </provider>
          </source>
          <packages>
            <package code="NewsEdge"/>
            <package code="CCS"/>
          </packages>
          <headline>
            Microsoft: 74 Device Partners Will Bring Office To Android
          </headline>
        </result>
      </results>
    </searchResults>
    
  2. Get a PDF version of story.
    Invoke a pdf/get request using the key parameter with the key value from the previous example. The story is formatted and displayed as PDF in the browser, assuming the browser is set to automatically view PDF files. Download the generated PDF as appropriate for your situation.

    Request
    https://secure.newsedge.com/opensapi/20/pdf/get?session=935DA0B364E9E130F0EC3827FC3CCC9C&key=Z7w4OpsnuNtXuWj2NfbgL8eCt5qBX2SZlKmEXvq9rSUiNWDIKYEU6SJDUeGoc523QgHNI4n8D6DYVL8cAm-bX2XmVtKxZqb2B5mjZ3sAxOxRKfJD5wHP8Uyu_09hpqAu
            

    Response
    A PDF document is returned.
            
  3. Get an RTF version of story.
    Invoke an rtf/get request using the key parameter with the key value from the previous example. Since browsers do not display RTF files, your browser will ask to download the file which you should save as an RTF file type.

    Request
    https://secure.newsedge.com/opensapi/20/rtf/get?session=935DA0B364E9E130F0EC3827FC3CCC9C&key=Z7w4OpsnuNtXuWj2NfbgL8eCt5qBX2SZlKmEXvq9rSUiNWDIKYEU6SJDUeGoc523QgHNI4n8D6DYVL8cAm-bX2XmVtKxZqb2B5mjZ3sAxOxRKfJD5wHP8Uyu_09hpqAu
            

    Response
    Save file downloaded as a type RTF.
            

news/read - Get the content of a news story

The news/read call gets the content and metadata of a story from an earlier search. Each story in a news/search response is represented by a result element. Use the entire content of the result's storyURL element as the news/read call. The results returned depend on your agreement with Acquire Media. Results usually include story metadata and the story content or a link to the story's content.

See also news/search to get a list of news stories and api/info where noun=news and verb=read.


Example

https://secure.newsedge.com/opensapi/20/news/read?key=<<storyURL-key>>[&allowRedirect=value]

Required Parameters

Parameter Values Description
keyIdentifier of a story's content from an earlier search. Returned results from a news/search represent each story with a result element, which contains the story's StoryURL element. The key is embedded in the StoryURL value.

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.
allowRedirectDefault:false
true, false
Use this parameter with Spider stories/Weblinked content to determine whether the user will be redirected to the original web site or the story will be displayed as the NewsEdge Simple News in XML format.

Returned Results

The results are in one of the following formats:

* Simple News in XML format, also known as SNiX

* Your custom business format, defined in coordination with an Acquire Media Implementation Manager.

The following describes some key elements of the SNiX format. The top-level of the SNiX format contains a header element of metadata and an asset element containing the story detail. For a complete description of the format, see the Acquire Media document, "NewsEdge Simple News in XML (SNiX)".

Required header elements

Name Values Description
idA globally unique identifier for the story. Guaranteed to never be reused. The id value may use upper and lower case letters, numbers, and any of the following characters dash (-), underscore (_), and asterisk (*). Its maximum length is 256 characters.
storyURLThe storyURL element is the URL to follow to read the full story. Multiple values of storyURL can point to the same story. The storyURL value may use upper and lower case letters, numbers, and any of the following characters dash (-), underscore (_), and asterisk (*).
publish-reasonOriginal, Corrected, DeletedThe publish-reason element indicates why this story is being released. Acquire Media maintains the list of allowed code values.

Standard attribute values are:

Original - The first (and perhaps only) release of this story.

Corrected - The story with all correction messages applied (used when a story has already been published with publish-reason "original").

Deleted - The provider has deleted the story.

typeNews, Spider, NIB, HO

The type element's code attribute specifies the general type of information in the asset content. The code values are defined by Acquire Media as:

News - A general news story, which is the most common type. The content element will contain a specific rendition of the story.

Spider - This story has been indexed from the Internet by Acquire Media.

NIB - This is a collection of short news summaries ("News in brief"). The newslines element usually consist of a headline and summary for several stories. Occasionally, they are a repeat of top stories from a particular service. They can be sent on any schedule such as daily, hourly, or ad hoc.

HO - This is a headline-only story. There is no story information contained in the content element.

business-relevance0 - 99The business-relevance element has a numeric value between 0 and 99. It is a numerical measure, assigned by Acquire Media, indicating the business applicability of this story.
dup0,1The dup element has a numeric value of 0 or 1. A one indicates that this story is a duplicate of another story from the same publisher.
publication-dateYYYYMMDDTHHMMSS-ZZZZThe publication-date specifies the date when the news story was officially published (which may not correspond to the actual release time). This published-date is formatted according to ISO 8601 basic standard.
user-display-publication-dateThe user-display-publication-date provides a human-readable version of the publication-date element. It also provides the isotimevalue attribute which is a format suitable for use by javascript, PHP and several other programming languages.
received-dateYYYYMMDDTHHMMSS-ZZZZThis element specifies the data and time Acquire Media received the story from the information provider. The received-date is formatted according to ISO 8601 basic standard.
user-display-received-dateThis element provides a human-readable version of the received-date element. It also provides the isotimevalue attribute which is a format suitable for use by javascript, PHP and several other programming languages.
lastchanged-dateYYYYMMDDTHHMMSS-ZZZZThis date element specifies the date and Tim the news story was last modified by the information provider in ISO 8601 basic format.
classification

The classification element contains the taxonomies and entities elements.

The taxonomies element contains the industry and subject taxonomic nodes that apply to this story.

The entities element contains the location, company and people entity-lists that apply to this story.

For more information about the classification element and its taxonomy and entities sub-elements, refer to the "NewsEdge Simple News in XML (SNiX)" document, section 4.3.

source

The source element contains the name, short-name, and code attributes. The name attribute is the Acquire Media full name for the publication. The short-name attribute is the text that should be displayed to the user as the source of the story. The code attribute can be used as a search term.

The source element contains the provider element. The provider element is the company that sends the story to NewsEdge.

The provider element contains one or more service elements. The service element describes, at a high level, the type of source.

The source element also contains source classification data:

topness - The NewsEdge content team deems this source to be extremely influential with high editorial value. Values are true or false.

content-type - The type of content from this source. Refer to the source/search query parameter description for the list of content-types.

media-type - The type of media from this source. Valid values are: Text, Graphic, Photo, Video, Audio, Data, Web.

rights - The rights element describes licensing rights. Valid values are: linked for spidered sources and cleared for licensed sources.

geo-origin - The geographic origin for this source. The format of this sub-element is the same as the Location entity-list in the classification/entities section.

geo-focus - The main geographic regions that this source concentrates on. The format of this sub-element is the same as the Location entity-list in the classification/entities section.

classification - The industries and/or subjects that this source primarily covers.

For more information about the source element and its sub-elements, refer to the "NewsEdge Simple News in XML (SNiX)" document, section 4.2.

packagesNewsEdge collects sources into groups called packages. A package can be identify the usage rights for that particular story. Please consult with your Acquire Media salesperson for more information.

Optional header elements

Name Values Description
wordcountIs a count of the words in the story body excluding any markup.
expiry-dateThe expiry-date element specifies the date and time when the customer must cease distribution of the news story, in other words, it is a scheduled kill. The date and time appear in ISO 8601 basic format.
references

The references element may contain zero or more reference elements. The references element contains a summary of every external reference that is related to this file.

The reference element has a required type attribute that contains a url to information related to the story. The type attribute can have the following values:

pub-source - the reference is the publishers presentation of this story.

URL - the reference is the source of this story. The story was spidered from the Internet and any read request of the storyURL will be re-directed to this URL.

authoritative - the reference is the final, definitive version of the story.

associated-media - the reference points to an image, video, audio, or other media file that is related to the story.

authoritative-media - the reference points to the media file that is the story.

The sub-element of reference is an item. The item sub-element is required and repeatable. The item element has a required href attribute that is the URI to the file being referenced. The item element has optional sub-elements to define relevant attributes of the file. The item sub-elements are:

mime-type - defines the format of the file in standard IANA MIME content types.

file-size-octets - defines the size of the referenced file in number of 8-bit bytes.

character-encoding - defines the character encoding of the referenced file in standard IANA character set identifiers.

resolution-dpi - defines the native resolution in dots per inch of the referenced picture or movie.

height-pixels - defines the native height in pixels of the referenced picture or movie.

width-pixels - defines the native width in pixels of the referenced picture or movie.

color-depth-bits - defines the native color depth in bits of the referenced picture or movie.

color-space - defines the native color encoding of the referenced picture or movie.

duration-seconds - defines the duration in seconds of the referenced sound or movie.

associated-mediaThe associated-media element contains zero or more item elements. Each item is repeatable and will contain one image sub-element. The parent item element contains an href attribute whose value points to the full size image of a reference item of type associated-media. The child image element is required and contains an href attribute whose value points to the thumbnail version of the parent item element.
authoritative-mediaThe authoritative-media element contains only one item element. The parent item element contains an href attribute whose value points to the full size image of a reference item of type authoritative-media. The child image element is required and contains an href attribute whose value points to the thumbnail version of the parent item element.

Required asset elements

Name Values Description
newslinesThe newslines element inside asset represents both metadata and story content with sub-elements such as headline and summary. Newslines describes the asset but is often displayed with it, e.g. showing the headline with the news story. The newslines element contains one required sub-element headline, and optional sub-elements deckline, byline, dateline, copyrightline, rightsline, and summary.

headline - The headline element provides the full title for the asset and is often displayed together with the asset.

deckline - The deckline element is repeatable, providing a subtitle for the asset.

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

dateline - The dateline element lists the time and/or place where the news was filed, in a free-form, unstructured text.

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

rightline - The rightsline element provides information about the customer's usage rights for a news asset, in a free-form, unstructured text.

summary - The summary element provides a short, free-form text summary of a news asset.


Optional asset elements

Name Values Description
content

The content element inside asset contains story information. The header required type code determines the kind of story information, either a specific rendition of the story or a link to the story stored externally.

The content element has either a reference element or inline block document elements, but shall not contain both.

reference - The reference element (either this or inline content is required) points to an external file using a URL, and is specified using the href attribute (required).

block document - The inline block document elements (either these or reference required) contains a textual payload inside the document itself. The text may contain XML markup, must not contain any characters prohibited by the XML specification, and must use the same character encoding as the rest of the document. For a complete description of the block and inline content elements , see the Acquire Media document, "NewsEdge Simple News in XML (SNiX)" section 5.2.2.

Acquire Media adds value to news item by attaching metadata not only to the item as a whole, but to specific locations in the story content, allowing customers to generate links, add photos or sidebars, or take other actions in a specific location in a story.

The inline document elements for the Acquire Media's NewsEdge Simple News in XML Format can be mixed inline with regular text to add semantic information or, in some cases, enhanced formatting to news stories. The following elements are allowed: location, chron, org, money, a, person, label, strong, br, em, and span. All of these elements are allowed in any text within the asset element.

location - The location element (optional, repeatable) surrounds a string of text describing a location, and uses the code attribute with the location entity value to identify the location.

chron - The chron element (optional, repeatable) surrounds a string of text describing a point in time. the chron element uses the norm attribute to give the date and time in ISO 8601 basic format.

org - The org element (optional, repeatable) surrounds a string of text describing a company or other organization, using the code attribute with the company entity value and a source attribute indicating the source for the organization entity code.

money - the money element (optional, repeatable) surrounds a string of text describing a quantity of currency. Two optional attributes may be assigned to the money element, unit described as ISO 4217 currency code, and norm, the value normalized into decimal format.

a - the a element surrounds text to be treated as a web link. This element has an href attribute specifying th web address for use as the URL. Internal links use the # character followed by the id of the element being linked to.

person - the person element surrounds a string of text describing a person.

label - the label element with the class attribute value of "highlight" surrounds a string of text identified as significant terms from the search query.

languageThe language element specifies the language of the text in the asset element. If the language element is missing, the default value is "en". If the source is missing, the default value is ISO 639-1.
dup-checkAn Acquire Media generated value used to identify duplicate stories.

media/read - Get an image file related to a news story

The media/read call gets the content of an image from a URL returned from either news/search or news/read in the references section.


Example

https://secure.newsedge.com/opensapi/20/media/read?file=<<media-key>>[&mediasize=value]

https://secure.newsedge.com/opensapi/20/media/read?file=<<media-key>>[&height=value]

https://secure.newsedge.com/opensapi/20/media/read?file=<<media-key>>[&width=value]

Require Parameters

Parameter Values Description
fileThis is the media key that is returned from a news/search or news/read call.

Optional Parameters

Parameter Values Description
mediasizeDefault:preview
original, thumbnail, midsize, or preview

The optional mediasize parameter can control the size of the image returned.

original - Return the image as was received from the provider. Note:This can return extremely large image files.

thumbnail - Returns an image that is 100px wide and retains the aspect ratio of the original.

midsize - Returns an image that is 200px wide and retains the aspect ratio of the original.

preview - Returns an image that is 400px wide and retains the aspect ratio of the original.

height

If the height parameter is specified, it will override the mediasize parameter. This will set the height of the returned image in pixels. The width will be set so that the returned image will retain the aspect ratio of the original.

If both the height and width parameters are specified, the media/read call will return an image that is sized to match the tightest constraint.

width

If the width parameter is specified, it will override the mediasize parameter. This will set the width of the returned image in pixels. The height will be set so that the returned image will retain the aspect ratio of the original.

If both the height and width parameters are specified, the media/read call will return an image that is sized to match the tightest constraint.

jsonDefault:0
0, 1, 2

If the json parameter is provided, this will only affect the return in the case of an error.

  • 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

If the call is successful, the image data will be returned. The content/type http header will indicate the mime type of the returned image. If there is an error, the elements described below are returned.

Results Elements

Name Values Description
statusThis indicates that there has been an ERROR with this call.
errorThis is a human-readable error message.

pdf/get - Get a PDF version of a story

The pdf/get request takes a story key as input and returns a PDF-formatted version of the story. See also api/info where &noun=pdf&verb=get.


Example

https://secure.newsedge.com/opensapi/20/pdf/get?session=<<user-token>>&key=<<storyURL-key>>

Required Parameters

Parameter Values Description
key

An identifier of a story’s content. The key is embedded in the URL of the storyURL element from news/search.

sessionThe ID of the OPENS API session. Use the value returned in the user-token element from session/login.

Returned Results

The returned results are a PDF-formatted version of the story. The story displays in the browser automatically if the browser is configured to view PDF files, otherwise, download the PDF file to your system and use a PDF viewer.

rtf/get - Get an RTF version of a story

The rtf/get request takes a story key as input and returns a rich text formatted version of the story. See also api/info where &noun=rtf&verb=get.


Example

https://secure.newsedge.com/opensapi/20/rtf/get?session=<<user-token>>&key=<<storyURL-key>>

Required Parameters

Parameter Values Description
key

An identifier of a story’s content. The key is embedded in the URL of the storyURL element from news/search.

sessionThe ID of the OPENS API session. Use the value returned in the user-token element from session/login.

Returned Results

The returned results are an RTF-formatted version of the story. The browser requests you download the RTF file to your system. Use an RTF viewer such as Microsoft Word to view the file.