Question

The Teltonika RMS API refers to a "q" parameter for "search query" (eg: /devices)

What format does this search query string require? Can someone provide an example?

Eg: https://rms.teltonika-networks.com/api/devices?q=...

Answer 1

Hello, 

Every API endpoint that has the 'q' parameter searches different values. A couple examples:

• The '/devices' endpoint 'q' parameter can search by device name, description, serial number, MAC address, and RMS company name of the registered device.
• The '/companies' endpoint 'q' parameter can search by company name, company ID, parent company name and parent company ID.

Format example for the '/devices' by searching for serial number: https://rms.teltonika-networks.com/api/devices?q=1234567890

Format example for the '/companies' by searching for company name: https://rms.teltonika-networks.com/api/companies?q=company123

Comments

So it's just a string search over the parameters? Can the query be more specific, similar to an OData filter expression or something?

---

Keep in mind, the parameter search cannot find all available information. For example, the '/devices' endpoint 'q' parameter search will not find the device's temperature or signal strength information. And no, it currently cannot be as specific as OData filter expressions, it is currently limited to single string searches of specific parameters.