Dave at 19:02, 21 August 2012

2012-08-21T19:02:23Z

Dave: 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..."

2012-08-21T18:58:55Z

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..."

New page

{{Infobox API
| name = Entity Search
| mode = entity_search
| description = Search an Entity
| parameters = entity, [fields], start, limit
| returned = 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

@@ Line 20: / Line 20: @@
 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
+XML containing search results on success or a [[API XML Error]] on failure.

API entity search - Revision history

Dave at 19:02, 21 August 2012

Dave: 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..."