Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
Update URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ttavenner
ttavenner authored Oct 14, 2016
1 parent c49a643 commit c9f95c7
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ It can be implemented using Flask with [WSGI on Apache/Nginx](http://flask.pocoo
<td colspan=2>
Can be searched by adding any or all of the following parameters:
<ul>
<li><b>Name</b><br />ex. <a href="http://api.openhealthinspection.com/vendors?name=Havana">api.openhealthinspection.com/vendors?name=Havana</a></li>
<li><b>Address</b><br />ex. <a href="http://api.openhealthinspection.com/vendors?address=Newtown%20Rd">api.openhealthinspection.com/vendors?address=Newtown Rd</a></li>
<li><b>City</b><br />ex. <a href="http://api.openhealthinspection.com/vendors?city=Richmond">api.openhealthinspection.com/vendors?city=Richmond</a></li>
<li><b>Locality</b>: The health district in which the vendor is located<br />ex. <a href="http://api.openhealthinspection.com/vendors?locality=Arlington%20Health%20District">api.openhealthinspection.com/vendors?locality=Arlington Health District</a></li>
<li><b>Category</b>: A broad categorization<br />ex. <a href="http://api.openhealthinspection.com/vendors?category=Restaurant">api.openhealthinspection.com/vendors?category=Restaurant</a></li>
<li><b>type</b>: A more granular breakdown<br />ex. <a href="http://api.openhealthinspection.com/vendors?type=Mobile%20Food%20Unit">api.openhealthinspection.com/vendors?type=Mobile Food Unit</a></li>
<li><b>Score Above Number</b><br />ex. <a href="http://api.openhealthinspection.com/vendors?score_above=70">api.openhealthinspection.com/vendors?score_above=70</a></li>
<li><b>Score Below Number</b><br />ex. <a href="http://api.openhealthinspection.com/vendors?score_below=90">api.openhealthinspection.com/vendors?score_below=90</a></li>
<li><b>Name</b><br />ex. <a href="https://ohi-api.code4hr.org/vendors?name=Havana">ohi-api.code4hr.org/vendors?name=Havana</a></li>
<li><b>Address</b><br />ex. <a href="https://ohi-api.code4hr.org/vendors?address=Newtown%20Rd">api.openhealthinspection.com/vendors?address=Newtown Rd</a></li>
<li><b>City</b><br />ex. <a href="https://ohi-api.code4hr.org/vendors?city=Richmond">ohi-api.code4hr.org/vendors?city=Richmond</a></li>
<li><b>Locality</b>: The health district in which the vendor is located<br />ex. <a href="https://ohi-api.code4hr.org/vendors?locality=Arlington">ohi-api.code4hr.org/vendors?locality=Arlington</a></li>
<li><b>Category</b>: A broad categorization<br />ex. <a href="https://ohi-api.code4hr.org/vendors?category=Restaurant">ohi-api.code4hr.org/vendors?category=Restaurant</a></li>
<li><b>type</b>: A more granular breakdown<br />ex. <a href="https://ohi-api.code4hr.org/vendors?type=Mobile%20Food%20Unit">ohi-api.code4hr.org/vendors?type=Mobile Food Unit</a></li>
<li><b>Score Above Number</b><br />ex. <a href="https://ohi-api.code4hr.org/vendors?score_above=70">ohi-api.code4hr.org/vendors?score_above=70</a></li>
<li><b>Score Below Number</b><br />ex. <a href="https://ohi-api.code4hr.org/vendors?score_below=90">ohi-api.code4hr.org/vendors?score_below=90</a></li>
<li><b>Limit</b><br />Sets a limit on the number of results returned. The default is 1,500.</li>
<li><b>Pretty</b><br />Formats the results for easier reading in a browser. values are 'true' and 'false'. Default is false.</li>
<li><b>Geospatial</b>: Vendors near to a certain point can be found by providing a starting latitude &lt;lat&gt;, longitude &lt;lng&gt;, and distance in meters &lt;dist&gt;
<br />ex. <a href="http://api.openhealthinspection.com/vendors?lat=36.6337272&lng=-81.7837303&dist=2000">api.openhealthinspection.com/vendors?lat=36.6337272&lng=-81.7837303&dist=2000</a></li>
<br />ex. <a href="https://ohi-api.code4hr.org/vendors?lat=36.6337272&lng=-81.7837303&dist=2000">ohi-api.code4hr.org/vendors?lat=36.6337272&lng=-81.7837303&dist=2000</a></li>
</ul>
This route returns name, API url, address, city, locality, category, type, score, and coordinates for each vendor. If a geospatial search was performed it will also return the distance from the starting point.</td>
</tr>
Expand All @@ -49,13 +49,13 @@ This route returns name, API url, address, city, locality, category, type, score
<td colspan=2>
Can be searched by adding any or all of the following parameters:
<ul>
<li><b>vendorid</b><br />ex. <a href="http://api.openhealthinspection.com/inspections?vendorid=molasses-grill-63-south-main-street">api.openhealthinspection.com/inspections?vendorid=molasses-grill-63-south-main-street</a></li>
<li><b>Inspections Performed Before Date</b>: Specified in the form DD-MM-YYYY<br />ex. <a href="http://api.openhealthinspection.com/inspections?before=15-09-2013">api.openhealthinspection.com/inspections?before=15-09-2013</a></li>
<li><b>Inspections Performed After Date</b>: Specified in the form DD-MM-YYYY<br />ex. <a href="http://api.openhealthinspection.com/inspections?after=29-02-2012">api.openhealthinspection.com/inspections?after=29-02-2012</a></li>
<li><b>Violation Text</b>: The inspector's description of the violation contains this text<br />ex. <a href="http://api.openhealthinspection.com/inspections?violation_text=candle">api.openhealthinspection.com/inspections?violation_text=candle</a></li>
<li><b>Violation Code</b>: The municipal code of the violation<br />ex. <a href="http://api.openhealthinspection.com/inspections?violation_code=303">api.openhealthinspection.com/inspections?violation_code=303</a></li>
<li><b>Score Above Number</b><br />ex. <a href="http://api.openhealthinspection.com/inspections?score_above=70">api.openhealthinspection.com/inspections?score_above=70</a></li>
<li><b>Score Below Number</b><br />ex. <a href="http://api.openhealthinspection.com/inspections?score_below=90">api.openhealthinspection.com/inspections?score_below=90</a></li>
<li><b>vendorid</b><br />ex. <a href="https://ohi-api.code4hr.org/inspections?vendorid=Backyard-Grillers-1078-Lee-Syd-Moore-Drive-Scottsburg-Virginia-24589">ohi-api.code4hr.org/inspections?vendorid=Backyard-Grillers-1078-Lee-Syd-Moore-Drive-Scottsburg-Virginia-24589</a></li>
<li><b>Inspections Performed Before Date</b>: Specified in the form DD-MM-YYYY<br />ex. <a href="https://ohi-api.code4hr.org/inspections?before=15-09-2013">ohi-api.code4hr.org/inspections?before=15-09-2013</a></li>
<li><b>Inspections Performed After Date</b>: Specified in the form DD-MM-YYYY<br />ex. <a href="https://ohi-api.code4hr.org/inspections?after=29-02-2012">ohi-api.code4hr.org/inspections?after=29-02-2012</a></li>
<li><b>Violation Text</b>: The inspector's description of the violation contains this text<br />ex. <a href="https://ohi-api.code4hr.org/inspections?violation_text=candle">ohi-api.code4hr.org/inspections?violation_text=candle</a></li>
<li><b>Violation Code</b>: The municipal code of the violation<br />ex. <a href="https://ohi-api.code4hr.org/inspections?violation_code=303">ohi-api.code4hr.org/inspections?violation_code=303</a></li>
<li><b>Score Above Number</b><br />ex. <a href="https://ohi-api.code4hr.org/inspections?score_above=70">ohi-api.code4hr.org/inspections?score_above=70</a></li>
<li><b>Score Below Number</b><br />ex. <a href="https://ohi-api.code4hr.org/inspections?score_below=90">ohi-api.code4hr.org/inspections?score_below=90</a></li>
</ul>
This route returns name, address, city, locality, category, type, score, last inspection date, and coordinates for each vendor. It will also return any inspections that met the search criteria.
</td>
Expand Down

0 comments on commit c9f95c7

Please sign in to comment.