kemApiV3DevicesSearchGet method

Future<Response<List<String>>> kemApiV3DevicesSearchGet({
  1. String? deviceText,
  2. String? userText,
  3. String? addressText,
  4. String? serialNumber,
  5. String? displayName,
  6. String? oncueUsername,
  7. String? email,
  8. bool? excludeDevicesWithDealers,
})

Search all devices and return a list of serial numbers for devices that contain text from the given input values. Fields are case insensitive. Multiple fields can be provided to make the search more precise.

If an oncueUsername and email are both provided, they must belong to the same user or a 403 Forbidden error will be returned @param DeviceText If provided, the search will return all devices with the given value contained in any of its device data fields (serial number, display name, or address fields). @param UserText If provided, the search will return all devices whose OnCue users have a username, email, or recipient that matches the given value. @param AddressText If provided, the search will return all devices with the given text in any of its address fields (address1, address2, city, state, postal code, or country) @param SerialNumber If provided, the search will return all devices whose serial number contains the given value. @param DisplayName If provided, the search will return all devices whose display name contains the given value. @param OncueUsername If provided, the search will return all devices that are associated with the OnCue user whose username matches the given value. The username must be an exact match, but can be case insensitive. @param Email If provided, the search will return all devices that are associated with the OnCue user whose email matches the given value. Additionally, devices with users who have the given email as a recipient in OnCue will also be included. The email must be an exact match, but can be case insensitive. If a username is also provided, the matching OnCue user must match this email. @param ExcludeDevicesWithDealers If set to true, the search will exclude devices that are already assigned to another dealer organization's fleet. If not provided, the value defaults to false, meaning devices that are already associated with a dealer will be included in the search.

Implementation

Future<chopper.Response<List<String>>> kemApiV3DevicesSearchGet({
  String? deviceText,
  String? userText,
  String? addressText,
  String? serialNumber,
  String? displayName,
  String? oncueUsername,
  String? email,
  bool? excludeDevicesWithDealers,
}) {
  return _kemApiV3DevicesSearchGet(
      deviceText: deviceText,
      userText: userText,
      addressText: addressText,
      serialNumber: serialNumber,
      displayName: displayName,
      oncueUsername: oncueUsername,
      email: email,
      excludeDevicesWithDealers: excludeDevicesWithDealers);
}