Filtering results

A large number of API methods that return results such as projects, jobs or companies permit to filter on any fields in the result set.

The name of this parameter is "filter" and is included in the url.

Example:

http://api.wordbee-translator.com:32490/projects?token=xxx&filter=ClientName="John"

 

Note: You may need to url-encode the "=" character in ClientName=John depending on your browser.

Boolean operators can be used as follows:


http://api.wordbee-translator.com:32490/projects?token=xxx&filter=ClientName="John" AND ProjectType="Codyt"


http://api.wordbee-translator.com:32490/projects?token=xxx&filter=ClientName="John" AND Reference.StartsWith("2010")


Filtering dates

To filter items by a date/time field please follow the following conventions:

Filter deadlines after a date:

  • Deadline >= DateTime(2018, 1, 25)    // Filter at or after January 25, 2018
  • Deadline < DateTime(2018, 1, 25, 10, 0, 0)   // Filter with deadline before January 25, 2018 at 10am


http://api.wordbee-translator.com:32490/projects?token=xxx&filter=DeadLine<DateTime(2017, 5, 29)


Note: Always URL encode the parameters, for the URL above this gives:

http://api.wordbee-translator.com:32490/projects?token=xxx&filter=DeadLine%3CDateTime%282017%2C+5%2C+29%29


A handy tool to encode the "filter" parameter value can be found here: http://www.url-encode-decode.com/

 



Copyright Wordbee - Buzzin' Outside the Box since 2008