API entity search
From FreeDESK
(Difference between revisions)
(Created page with "{{Infobox API | name = Entity Search | mode = entity_search | description = Search an Entity | parameters = entity, [fields], start, limit | returned = XML login error or sess...") |
Revision as of 18:58, 21 August 2012
| Entity Search | |
| Call/Mode: | entity_search |
|---|---|
| Description: | Search an Entity |
| Parameters: | entity, [fields], start, limit |
| Returned Data: | XML login error or session data |
This article details a FreeDESK API call.
Description
The entity_search call will search a registered entity (with valid permissions) and return matches
Using the Call
Pass in the following parameters using GET or POST
- entity : Entity
- start : Start (0 for beginning)
- limit : Limit number of results (default 30)
- [fields] : In the form of:
fieldname=value
For example
api.php?mode=entity_search&entity=customer&firstname=david
Would search the customer entity for records with the firstname of david (starting at the beginning and returning a max of 30 results)
Returned Data
XML containing search results on success or a
