Sugar Network/API: Difference between revisions

(One intermediate revision by the same user not shown)

Line 45:

* [http://localhost:5001/ localhost:5001] default url to get access to [[#Client_API|local proxy]] provided from user side application; ; default API version is ''0.1''.

== ~~Sugar Network resources~~ ==

== Resources ==

Line 89:

* {{Code|offset}}, ''int'' start index to return entries from, the default value is {{Code|0}};

* {{Code|limit}}, ''int'' do not return more then specified value, maximal and default values are being setup on server side;

* {{Code|query}}, ''str'' search request in [http://xapian.org/docs/queryparser.html Xapian] notation ~~with the following additions:~~

* {{Code|query}}, ''str'' search request in [http://xapian.org/docs/queryparser.html Xapian] notation; if property is boolean, integer or datetime, it supports searching by ranges, i.e., {{Code|''PROP'':[''START'']..[''END'']}};

** if property is boolean, integer or datetime, it supports searching by ranges: {{Code|''PROP'':[''START'']..[''END'']}};

** the statement {{Code|''PROP''<nowiki>:=</nowiki>["]''VALUE''["]}} has the same effect as {{Code|QUERY_PROP}}; it is different to regular {{Code|''PROP'':''VALUE''}} where {{Code|VALUE}} might be a substring;

* {{Code|PROP}}, ''str'' supplements {{Code|query}} with filtering by exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;

* {{Code|!PROP}}, ''str'' supplements {{Code|query}} by excluding exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|NOT ''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;

@@ Line 45: / Line 45: @@
 * [http://localhost:5001/ localhost:5001]<br>default url to get access to [[#Client_API|local proxy]] provided from user side application; ; default API version is ''0.1''.
-== Sugar Network resources ==
+== Resources ==
 {{:Sugar_Network/Resources}}
@@ Line 89: / Line 89: @@
 * {{Code|offset}}, ''int''<br>start index to return entries from, the default value is {{Code|0}};
 * {{Code|limit}}, ''int''<br>do not return more then specified value, maximal and default values are being setup on server side;
-* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation with the following additions:
+* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation; if property is boolean, integer or datetime, it supports searching by ranges, i.e., {{Code|''PROP'':[''START'']..[''END'']}};
-** if property is boolean, integer or datetime, it supports searching by ranges: {{Code|''PROP'':[''START'']..[''END'']}};
-** the statement {{Code|''PROP''<nowiki>:=</nowiki>["]''VALUE''["]}} has the same effect as {{Code|QUERY_PROP}}; it is different to regular {{Code|''PROP'':''VALUE''}} where {{Code|VALUE}} might be a substring;
 * {{Code|PROP}}, ''str''<br>supplements {{Code|query}} with filtering by exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;
 * {{Code|!PROP}}, ''str''<br>supplements {{Code|query}} by excluding exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|NOT ''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;