From 625e0db3ae125467979d9b871c62cf6609ff15c2 Mon Sep 17 00:00:00 2001 From: alext Date: Tue, 2 Jan 2018 11:27:12 +0100 Subject: [PATCH] Added explanation for the generation of aggregates. --- doc/rest-api.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/rest-api.md b/doc/rest-api.md index 4ee1fd26..55b6d74c 100644 --- a/doc/rest-api.md +++ b/doc/rest-api.md @@ -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 ``` +### 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 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: