Search parameter
How can the search parameter be used on an endpoint? How does the search syntax work?
Search
Pass the user search value into the search parameter, the search value itself is transformed by the API to support a more natural (google) search!
- Text is converted to UPPER case
- All diacritics like é,ö etc.. are replaced with the normal character e.g. Ê > E
- Duplicate spaces, tabs, newlines are removed
- All characters not in 0-9 A-Z are removed
- Words are split on spaces, the search is performed on ALL words
The search words are matched against the columns defined per specific endpoint, see below.
Input
Search = text, string
Output
JSON
filtered result set of the items
Sample
# Sample: BMW
BMW
Result:
All results with BMW
# Sample: Citroën
Citroën
Result:
All results with CITROEN
# Sample: BMW 5-series
BMW 5-series
Result:
All results with:
BMW <AND> 5SERIES
Specifics per endpoint
Per endpoint search can be used only on the fields that are available on the model for the specific endpoint. See below for more information.
Contact
The following columns are used for the search
| Columns |
|---|
| firstname |
| lastname |
| shortname |
| company_name |
| postalcode |
| address |
| city |
Related data contact_communication
| Columns |
|---|
| communication_value |
Related data vehicle_role_line to vehicle
| Column |
|---|
| license_plate |
Vehicle
The following columns are used for the search
| Columns |
|---|
| license_plate |
| model |
| brand |
| chassis_number |
| vehicle_version |
Related vehicle_role_line to contact
| Columns |
|---|
| firstname |
| lastname |
| shortname |
| company_name |
Orders
The following columns are used for the search
| Columns |
|---|
| order_number |
| description |
Related data order to contact
| Columns |
|---|
| firstname |
| lastname |
| shortname |
| company_name |
Related data contact_communication
| Columns |
|---|
| communication_value |