The Zywave API search is implemented using OData Version 4.01.
OData searches are comprised of four optional query parameters:
$filter is not set, no records will be excluded
from the result set. If
$orderBy is not set, the order of records in the result set will be
$skip parameter defaults to 0 and the
$top parameter will default to 100.
In other words, if
$top are both omitted from the search, then the first 100
records of the result set (or all records if there are 100 or fewer) will be returned in the order (if any) specified
OData filters are built by combining boolean expressions with
boolean operators. The expressions within a filter are created by comparing a property with one or more literal values using
supported comparison operators. The following comparison operations are supported by the Zywave API; each is accompanied
by an example request. Note that string operations are case insensitive.
Namestarts with 'Zyw'
Nameends with 'wave'
Name eq 'Zywave'
Name ne 'Zywave'
Nameis not 'Zywave'
Price gt 4.5
Priceis greater than 4.5
ge(Greater Than Or Equals)
Price ge 4.5
Priceis greater than or equal to 4.5
Price lt 4.5
Priceis less than 4.5
le(Less Than Or Equals)
Price le 4.5
Priceis less than or equal to 4.5
in(Exactly Matches At Least One Of)
Name in ('Zyw', 'ave')
Nameis either 'Zyw' or 'ave'.
When querying the Zywave API against a DateTime field, use the format YYYY-MM-DDTHH:MM:SS.fffZ. For example, the following filter will return all
State equal to 'WI' and
UpdatedDateTime on or after January of 2019:
State eq 'WI' and UpdatedDateTime ge 2019-01-01T00:00:00.000Z
To order the result set by one or more properties, specify the property name and either
asc for ascending or
descending in the
$orderBy parameter. For example, the following
$orderBy value will return records in descending
updateDateTime (most recent first) and alphabetically by
updatedDateTime desc, name asc
The Zywave search methods use the OData
$top query options to retrieve specific
subsets of the full result set. When the
$skip option is used, the first
of the full result set are excluded. When the
$top option is used, only the first
records of the result set are returned. The
$skip option is always applied before the
option. For example, if there are 100 records in the full result set, and you wish to only show records 21 through 25, then
$skip should be set to 20 and
$top should be set to 5.
$orderByis not set, then the order of results retrieved from the server is indeterminate. In order to paginate correctly, you must set the