Satio Solutions - REST Information

PRODUCTS

Components
- dQ-Biz
  - Overview
  - Detail
  - Demo
  - Download
- dQ-Who
  - Overview
  - Detail
  - Demo
  - Download
- dQ-Address
  - Overview
  - Detail
  - Demo
  - Download
Web Services
- Overview
- Detail
  - dQ-Biz
  - dQ-Who
  - dQ-Address
- Demo
  - dQ-Biz
  - dQ-Who
  - dQ-Address
Data Services

SUPPORT

PARTNERS

Overview
Registration

COMPANY

RESOURCES

Creating a REST Request

Satio Solutions' Web Services are all REST services. That means you can easily construct request URLs that will work in your browser, on the command line, and in your code. Supported languages include Java, Javascript, Perl, Python and PHP. See below for sample PHP code.

URL Construction

All search request URLs start with the hostname and resemble the following sample:
http://services.satio.com/dq/

Next is the method followed by a question mark.
wservice.aspx?

Those components form the base URL.
http://services.satio.com/dq/wservice.aspx?

The method is followed by the parameters, which take the form argument=value. Multiple parameters are separated by an ampersand (&). The following example submits a Firm name to the dQ-Biz service for upper/lower casing:

http://services.satio.com/dq/wservice.aspx?userid=satiouser&service=dqbiz&linein=satio%solutions&uplow=Y

The documentation for each service provides the service name and lists all of the mandatory and optional parameters, in addition to describing the XML response structure, etc.

Sample PHP code

** PHP Code to submit requests to dQ-Biz and process the resulting XML dataset
<?php

  $Uplow = $ForceUpper = $AddPunc = $StdWords = $AbbrevWords = $SplitLine = $ObsceneFlag = $AddressFlag = $NameFlag = $TruncFlag = "N";
  $UpLow = "Y";
  $AddPunc = "Y";
  $MaxOutputLength = "50";
  
  // Do we have a process request?
  if(!empty($_REQUEST['LineIn']) )
  {

     // Construct the URL
     $q = "http://services.satio.com/dq/wservice.aspx?userid=satiouser&service=dqbiz";
	 $q = $q . "&LineIn="          . rawurlencode($_REQUEST['LineIn']);
	 $q = $q . "&UpLow="           . rawurlencode($_REQUEST['UpLow']);
	 $q = $q . "&ForceUpper="      . rawurlencode($_REQUEST['ForceUpper']);
	 $q = $q . "&AddPunc="         . rawurlencode($_REQUEST['AddPunc']);
	 $q = $q . "&StdWords="        . rawurlencode($_REQUEST['StdWords']);
	 $q = $q . "&AbbrevWords="     . rawurlencode($_REQUEST['AbbrevWords']);
	 $q = $q . "&SplitLine="       . rawurlencode($_REQUEST['SplitLine']);
	 $q = $q . "&MaxOutputLength=" . rawurlencode($_REQUEST['MaxOutputLength']);

     // Submit for processing
     $xml = file_get_contents($q);

      // Load XML block from server
      if (!$dom = domxml_open_mem($xml,DOMXML_LOAD_PARSING,$error))
      {
        echo "XML parse error\n";  foreach ($error as $errorline)   {    echo $errorline['errormessage']."<br />\n";    echo " Node  : " . $errorline['nodename'] . "<br />\n";    echo " Line  : " . $errorline['line'] . "<br />\n";    echo " Column : " . $errorline['col'] . "<br />\n";  }
      }

      // Get result set
      $root = $dom->document_element();
      $node = $root->first_child();
  
      // Extract our results from the node
      while($node) 
      {
           switch ($node->tagname)
           { 
             case 'LineIn' : {$LineIn = $node->get_content();  break;}
             case 'UpLow' : {$UpLow = $node->get_content();  break;}
             case 'ForceUpper' : {$ForceUpper = $node->get_content();  break;}
             case 'AddPunc' : {$AddPunc = $node->get_content();  break;}
             case 'StdWords' : {$StdWords = $node->get_content();  break;}
             case 'AbbrevWords' : {$AbbrevWords = $node->get_content(); break;}
             case 'SplitLine' : {$SplitLine = $node->get_content();  break;}
             case 'MaxOutputLength' : {$MaxOutputLength = $node->get_content();  break;}
             case 'oFirmLine1' : {$oFirmLine1 = $node->get_content();  break;}
             case 'oFirmLine2' : {$oFirmLine2 = $node->get_content();  break;}
             case 'ObsceneFlag' : {$ObsceneFlag = $node->get_content();  break;}
             case 'AddressFlag' : {$AddressFlag = $node->get_content();  break;}
             case 'NameFlag' : {$NameFlag = $node->get_content();  break;}
             case 'TruncFlag' : {$TruncFlag = $node->get_content();  break;}
           }
         $node = $node->next_sibling();
      }  
    } // End of request processing


    // Variable settings for form control.....
    if ($UpLow == 'Y') $formUplow = "checked";
	if ($ForceUpper == 'Y') $formForceUpper = "checked";
	if ($AddPunc == 'Y') $formAddPunc = "checked";
	if ($StdWords == 'Y') $formStdWords = "checked";
	if ($AbbrevWords == 'Y') $formAbbrevWords = "checked";
	if ($SplitLine == 'Y') $formSplitLine = "checked";

    if ($ObsceneFlag == 'Y') $formObsceneFlag = "checked";
	if ($AddressFlag == 'Y') $formAddressFlag = "checked";
	if ($NameFlag == 'Y') $formNameFlag = "checked";
	if ($TruncFlag == 'Y') $formTruncFlag = "checked";	


?>

** HTML Code for the FORM

<form action="http://www.satio.com/dqbiz_demo.php" method="post">
 Input Firm Name:&nbsp; <input type="text" name="LineIn" size="50" value="<? echo $LineIn; ?>">&nbsp;&nbsp;<input type="submit" name="Submit" value="Process" />
 <hr>	  	  
     <table border="1" bordercolor="#000000" width="466">
        <tr class="left"><td align="center">dQ Biz Presentation Options</td></tr>

        <tr class="leftlight"><td>
                <input type="checkbox" name="UpLow"       value="Y" <? echo $formUplow; ?> >Upper Lower Case Firm<br>
                <input type="checkbox" name="ForceUpper"  value="Y" <? echo $formForceUpper; ?> >Force Upper Case<br>
                <input type="checkbox" name="AddPunc"     value="Y" <? echo $formAddPunc; ?> >Add Punctuation to Firm<br>
                <input type="checkbox" name="StdWords"    value="Y" <? echo $formStdWords; ?> >Standardize Firm Words<br>
		</td></tr>

        <tr class="left"><td align="center">dQ Biz Length Options</td></tr>

        <tr class="leftlight"><td>
                Maximum output field length: <input type="txt" name=MaxOutputLength size="3" value="<? echo $MaxOutputLength; ?>"><br><br>
                <input type="checkbox" name=AbbrevWords value="Y" <? echo $formAbbrevWords; ?> >Abbreviate words, if necessary<br>
                <input type="checkbox" name="SplitLine" value="Y" <? echo $formSplitLine; ?> >Split into two lines, if necessary<br>
        </td></tr>

        <tr class="left"><td align="center">dq Biz Output</td></tr>

        <tr class="leftlight"><td>
                       <table border="0" width="100%">
                               <tr class="leftlight"><td width="35%"><b>Firm Line 1:</b> </td><td width="65%"><input type="text" value="<? echo $oFirmLine1; ?>" name="oFirmLine1" size="50"></td></tr>
                               <tr class="leftlight"><td width="35%"><b>Firm Line 2:</b> </td><td width="65%"><input type="text" value="<? echo $oFirmLine2; ?>" name="oFirmLine2" size="50"></td></tr>
		  					   <tr class="leftlight"><td colspan="3">
                                          <input type="checkbox" name="AddressFlag"   value="Y" <? echo $formAddressFlag; ?> >Possible Address<br>
                                          <input type="checkbox" name="NameFlag"  value="Y" <? echo $formNameFlag; ?> >Possible Name<br>
                                          <input type="checkbox" name="ObsceneFlag"     value="Y" <? echo $formObsceneFlag; ?> >Obscene word present<br>
                                          <input type="checkbox" name="TruncFlag"    value="Y" <? echo $formTruncFlag; ?> >Truncated field<br>
							    </td></tr>																			 
						</table>
         </td></tr>
     </table>
</form>