Filter Reference; Testing Code In The Browser - MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Use Manual

Filter reference

Filters are comprised of a type (either
field, if needed, and finally, the value of the field name, as shown in the following example:
Type-Modifier-FieldName=Value
The following table lists all the filter types and modifiers you can use with Breeze:
Type Modifier
filter (none)
filter like
filter out
filter rows
filter start
filter gt
filter lt
filter gte
filter lte
sort (none)

Testing code in the browser

You can enter a test URL in the address field of a browser window and see the XML response
from the server. It is a good idea to become comfortable with filters in the browser before you
write code.
There are many nuances to filters that determine which types of filters you can use with certain
API calls. The browser approach lets you quickly try combinations to see what works and what
doesn't. If you try this outside the browser, you add the extra time of compiling, loading the result
in your application server, and debugging to see if a filter works as you expect. Using a browser,
on the other hand, is much faster and gives you immediate feedback.
For example, you could use the following URL and filter to find all courses with the word "filter"
in the name and the word "date" in the course description. This example URL uses
breezedev.mycompany.com
sure you log on to the server first, and then enter the following URL, substituting your server
name for
breezedev.mycompany.com
http://breezedev.mycompany.com/api/xml?accesskey= myf1rst@pp^&action=report-
my-courses&filter-like-name=filter&filter-like-description=date
24 Chapter 2: Working with Filters
filter
Description
Field must match value exactly.
Field must contain value.
Field cannot contain value.
Limits the return result to number of rows specified in value. Does not use the
field name.
Limits the return result to number of rows specified in value. Does not use the
field name.
Selects all items greater than the value. Works only with dates.
Selects all items greater than the value. Works only with dates.
Selects all items greater than or equal to the value. Works only with dates.
Selects all items less than or equal to the value. Works only with dates.
Sorts results. Value must be
as the server name and
and your API access key for
or ) with an optional modifier, the name of the
sort
or .
asc desc
for the API access key. Make
myf1rst@pp^
:
myf1rst@pp^