About SearchEntity
The search can be applied on any indexed item of an entity. Filtering and partial searches are supported.
For example, Vendor name of "John Smith" and address "1234 Mission Lane" are indexed as: "John", "Smith", "1234", "Mission" and "Lane". A search on any of these words will return this vendor.
Note: Currently, only Vendor object indexes can be searched.
Example
Request
<API_URL_EndPoint>/SearchEntity.json
data={
"term" : "John",
"entity" : "Vendor"
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : [ {
"entity" : "Vendor",
"id" : "00901BJEXYBGWFSEoqug",
"isActive" : "1",
"name" : "John Smith",
"shortName" : null,
"nameOnCheck" : null,
"accNumber" : null,
"taxId" : "",
"track1099" : false,
"address1" : null,
"address2" : null,
"address3" : null,
"address4" : null,
"addressCity" : null,
"addressState" : null,
"addressZip" : null,
"addressCountry" : "United States",
"email" : null,
"fax" : null,
"phone" : null,
"payBy" : "0",
"paymentEmail" : null,
"paymentPhone" : null,
"description" : null,
"createdTime" : "2016-11-13T17:26:21.000+0000",
"updatedTime" : "2016-11-13T17:26:21.000+0000"
}, {
"entity" : "Vendor",
"id" : "00901GLCFWYGWSZDoquc",
"isActive" : "1",
"name" : "John Clark",
"shortName" : null,
"nameOnCheck" : null,
"accNumber" : null,
"taxId" : "",
"track1099" : false,
"address1" : null,
"address2" : null,
"address3" : null,
"address4" : null,
"addressCity" : null,
"addressState" : null,
"addressZip" : null,
"addressCountry" : "United States",
"email" : null,
"fax" : null,
"phone" : null,
"payBy" : "0",
"paymentEmail" : null,
"paymentPhone" : null,
"description" : null,
"createdTime" : "2016-11-13T17:26:08.000+0000",
"updatedTime" : "2016-11-13T17:26:08.000+0000"
} ]
}
Parameters
Field Name | Description | Required? |
---|---|---|
term | Keyword to search. To include quotes in search term, use escaped quotes. | Yes |
entity | Entity to be searched. Currently, only Vendor is supported. | Yes |