@extends('maindash2')
@section('htmlheader_title')
API Documentation
@endsection
@section('content')
You can integrate key waste and recycling charts into your applications dashboard by making calls to our REST APT.
API Documentation
Parameters
q=(quantity)s=(size)f=(frequency)r=(trash or total rate)/rc=(recycling quantity)rs=(recycling size)rf=(recycling frequency)rr=(recycling rate)rent=(rental rate)hr=(haul rate)tph=(tons per haul)delta=(change as percentage)
Resource URL's
Total Yards
http://localhost:8000/yds/q=(quantity)s=(size)f=(frequency)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)
Total Yards Compacted
http://localhost:8000/compyds/q=(quantity)s=(size)f=(frequency)
Price Per Yard
http://localhost:8000/ppy/q=(quantity)s=(size)f=(frequency)r=(trash or total rate)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)rr=(recycling rate)
Tons Per Month MSW & Recycling
http://localhost:8000/tmonth/q=(quantity)s=(size)f=(frequency)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)
Restaurant Tons Per Month MSW & Recycling
http://localhost:8000/tmonthr/q=(quantity)s=(size)f=(frequency)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)
*All Metrics
http://localhost:8000/metrics/q=(quantity)s=(size)f=(frequency)r=(trash or total rate)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)rr=(recycling rate)
All Restaurant Metrics
http://localhost:8000/metricsr/q=(quantity)s=(size)f=(frequency)r=(trash or total rate)/rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)/rr=(recycling rate)
Compactor Metrics
http://localhost:8000/compmetrics/q=(quantity)s=(size)f=(frequency)rent=(rent)/hr=(haul rate)dr=(disposal rate)tph=(tons per haule)
Compactor Metrics improved
http://localhost:8000/compmetricsi/q=(quantity)s=(size)f=(frequency)rent=(rent)/hr=(haul rate)dr=(disposal rate)tph=(tons per haule)delta=(delta)
Get the latest on highway US Diesel Retail Price
http://localhost:8000/drpw
*Try hmetrics for a human UI
e.g. http://localhost:8000/hmetrics/q=(quantity)s=(size)f=(frequency)r=(rate)rq=(recycling quantity)rs=(recycling size)rf=(recycling frequency)rr=(recycling rate)
All parameters required so place a '0' in empty parameters e.g. Price Per Yard = http://localhost:8000/ppy/1/8/3/650.75/0/0/0/0 if you do not have recycling service or
http://localhost:8000/ppy/q=1s=8f=3r=650.75/rq=1rs=4rf=1rr=0 if recycling rate is not itemized on your vendor's invoice
Resource URL's for API access to the database - requires basic authentication
Diversion - http://localhost:8000/diversion
Exception - http://localhost:8000/exception
Trashtable - http://localhost:8000/trashtable
Contract - http://localhost:8000/contract
Usage Example:
trash service is 2 - 8 yard containers picked up 3 times per week
recycling service is 1 - 4 yard container picked up 1 time per week
Total Yards API call - 10.0.0.58/warm/public/yds/q=2s=8f=3/rq=1rs=4rf=1
Included Trash Functions
Total Yards = yds($q, $s, $f, $cr = 1) fourth argument compaction ratio defaults to 1
Price Per Yard = ppy($q, $s, $f, $p)
Tons Per Month = tmonth($q, $s, $f, $lbspy = 140) fourth argument lbs/yard defaults to 140 change per waste stream
Diversion Rate = diversion($q, $s, $f, $rq, $rs, $rf, $tlbspy = 140, $rlbspy = 143) trash lbs/yard defaults to 140,
recycling lbs/yard defaults to 143 change per waste stream
Savings From Avoided Disposal Cost = sadc($tq, $ts, $tf, $tp, $rq, $rs, $rf, $rp)
Monthly Compactor Rate = comprate($q, $s, $f, $rent, $hr, $dr, $tph, $cr = 3)
Roadmap
Add forms for data entry
Add Document Repository
Add Payment Gateway
Dashboard Documentation
3 levels of authentication
Executive, Regional, Site
@stop