mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-26 09:53:34 +03:00
Code Issues Projects Releases Packages Wiki Activity

Added explanation for the generation of aggregates.

Browse source
This commit is contained in:
alext 2018-01-02 11:27:12 +01:00
parent 85dec33466
commit 625e0db3ae
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/rest-api.md
View file

@ -46,6 +46,16 @@ If you need to get only specific values from each JSON resource provide the `fie
http://ea-installation/index.php/api/v1/appointments?fields=id,book,hash,notes http://ea-installation/index.php/api/v1/appointments?fields=id,book,hash,notes
``` ```
### Aggregate
Aggregate related data into result payload by providing the `aggregates` parameter.
```
http://ea-installation/index.php/api/v1/appointments?aggregates
```
*This parameter is currently only available for appointment resources.*
### Expected Responses ### Expected Responses
Most of the times the API will return the complete requested data in a JSON string but there are some cases that the responses will contain a simple message like the following: Most of the times the API will return the complete requested data in a JSON string but there are some cases that the responses will contain a simple message like the following: