milestone / leapi
Laravel ePlus API
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:laravel-package
README
Installation
Include package
composer require milestone/leapi
Publish
php artisan vendor:publish
Add clients in config > leapi.php
in the format
'key' => 'name'
Can add as many client required..
Once done, things are ready, Data can be fetched as per the below details...
URL Format:
/leapi/{client}/{action}/{table}
client any key added in config > leapi.php
action get or set, for getting or setting data respectively
table the name of the table from where the data required
get Parameters
id=1 id=10,11 for getting data of specified id
limit=0,100 for getting 100 number of data after skipping 0 records.
count if the parameters have a key named count, then the count of query will be returned
fields=id fields=date,progress returns only specified columns only
order_by=id,asc to sort records by id in ascending order. supported directions are asc,desc
Conditions
conditions can be given by
<column_name>=value Ex: id=4,progress=billed.
If other than equal operator, it should be given as <column_name>_operator=<
Ex: date=2022-10-31 18:15:00&date_operator=> this will fetch records having date greater than 2022-10-31 18:15:00
If there is no operator given, and values are given as coma seperated like completed,served, then operator will be assigned as in
Ex: progress=completed,served will fetch all records having progress as completed or served
Aggregator functions
max=price returns the maximum value of price. max=id this will return maximum of id. If passed without value, then max=id will be considered
min=price returns the minimum value of price. min=id this will return minimum of id. If passed without value, then min=id will be considered
avg=price returns the average value of price. avg=id this will return average of id. If passed without value, then avg=id will be considered
sum=price returns the sum value of price. sum=id this will return sum of id. If passed without value, then sum=id will be considered