Finwin Soap (Story)

Actions:

Quote

Story

Soap (Storys)

If your SOAP action is Story, you must use the storynumber node in your content request. Set the storynumber node to contain the story_id of a story from a headline request. The result will be a return packet with the full text and other data pertaining to that story. The return data includes a "recordcount" node that indicates the total number of records returned (in this case usually 1 - if your storynumber is valid).

The rsStory Node will contain child nodes of:

Date_line - descriptive date and time from pubisher (note: this is not a date time data type - use publish_date for that).
Distributor - Code representing the distributor. See entry for headlines for a discription of FinWin news distributors.
Headline - the headline for the story.
Issuer - Company issuing the story (if it's a press release for example)
Issuer_city - location of issuer (if applicable).
Issuer_postal_code - zip code of isssuer (if applicable).
Issuer_state - state of issuer (if applicable).
Publish_date - dateTime that the item was published.
Review - this value is set to 1 if FSS suspects a problem with the submission of the story.
Story_id - the ID number for this story in the FSS database.

Parameters
Username - The developers username you chose when you enrolled as a FinWin developer. Password - The developers password you chose when you enrolled as a finwin developer. ID - The site ID issued by FinWin when you enrolled this Site to receive FinWin content. Note: If you are developing your site and do not yet havea paid FinWin ID you may use the Complimentary developers site ID of 1183. Storynumber - story_id from a headline request. This identifies the story you are retrieving.

Request Structure

A SOAP action of Story takes only one required parameter beyond the standard username, password and id. That parameter is storynumber. A story number is typically the result of a "headlines" request. A headlines request returns a field called story_id that is an integer. This story_id can be passed back to FSS as the storynumber node of a requet packet to retrieve the full text of the story (and related meta data). As in all FSS requests, after the standard SOAP envelope and header, a SOAP request packet must have a node titled <ContentRequest xmlns='www.finwin.com'></ContentRequest>. This node contains child nodes that allow FSS to authorize and process your reqest - as in the example:

<?xml version='1.0'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
   xmlns:xsd="http://www.w3.org/1999/XMLSchema">
    <SOAP-ENV:Body>
       <ContentRequest xmlns='www.finwin.com'>
         <REQUEST xsi:type="xsd:string">Quote</REQUEST>
         <USERNAME xsi:type="xsd:string">Sillyname</USERNAME>
         <PASSWORD xsi:type="xsd:string">sillypassword</PASSWORD>
         <ID xsi:type="xsd:string">1183</ID>				
         <SYMBOLS xsi:type="xsd:string">msft</SYMBOLS>					
         <SEARCHSTRING xsi:type="xsd:string"></SEARCHSTRING>
         <STORYNUMBER xsi:type="xsd:string"></STORYNUMBER>		
         <PAGEID xsi:type="xsd:int"></PAGEID>	
         <ROWCOUNT xsi:type="xsd:int"></ROWCOUNT>	
       </ContentRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Return Data

			
<?xml version='1.0'?>
   <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
     xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
     xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
     xmlns:xsd="http://www.w3.org/1999/XMLSchema">
     <SOAP-ENV:Body>
       <Recordcount xsi:type="xsd:int">5</Recordcount>
       <Results xmlns="http://www.finwin.com">
         <rsSymbolNews> 
           <BODY xsi:type="xsd:string">
             &lt;P CLASS=&quot;BODY&quot;&gt; (RealTimeTraders.com) 
             ...body of the story goes here...
           </BODY>
           <DATE_LINE xsi:type="xsd:string">15:12 Wednesday, March 20, 2002</DATE_LINE>
           <DISTRIBUTOR xsi:type="xsd:string">RTT</DISTRIBUTOR>
           <HEADLINE xsi:type="xsd:string">Citigroup To Utilize Microsoft`s .NET Technologies - Update</HEADLINE>
           <ISSUER xsi:type="xsd:string"></ISSUER>
           <ISSUER_CITY xsi:type="xsd:string"></ISSUER_CITY>
           <ISSUER_POSTAL_CODE xsi:type="xsd:string"></ISSUER_POSTAL_CODE>
           <ISSUER_STATE xsi:type="xsd:string"></ISSUER_STATE>
           <PUBLISH_DATE xsi:type="xsd:date">2002-03-20 15:12:00</PUBLISH_DATE>
           <REVIEW xsi:type="xsd:int">0</REVIEW>
           <STORY_ID xsi:type="xsd:int">629775</STORY_ID>
         </rsSymbolNews>
       </Results>
     </SOAP-ENV:Body></SOAP-ENV:Envelope>

Fault Packets

FSS returns error descriptions as a soap packet with a "<Soapfault></Soapfault>" node in the results. An FSS SOAP fault packet looks like this:

					
<?xml version='1.0'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
   xmlns:xsd="http://www.w3.org/1999/XMLSchema">
   <SOAP-ENV:Body>
     <Results xmlns="http://www.finwin.com">
        <SoapFault>
          <EXCEPTION xsi:type="xsd:string">Username or password incorrect</EXCEPTION>
        </SoapFault>
     </Results>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

FSS Returns the following messages as SOAPFaults:

Method not allowed - Returned when you use an HTTP GET rather than a POST request. This return message also generates a 405 HTTP status code in the response header.
Missing SOAPAction Header - returned when no header titled SOAPAction was found.
Invalid SOAPAction Value - n is not a valid action - returned when the SOAPAction header contains an invalid or unrecognized SOAPAction
Missing Content-Type Header - A header named "content-type" was not found in your HTTP request
Invalid Content Type - your content-type header specifies something other than text/xml
Username Required - You did not provide a username in the request packet.
password Required - You did not provide a password in the request packet.
id Required - You did not provide a site id in the request packet.
Invalid Site ID - Your site ID is either unauthorized or not found.
Username or password incorrect - Your username and password are unauthorized or not found.