Skip to main content

RSImportRequest

toImport objectnullable
property name* RSImportRecord
tenantId stringnullable
sheduleStartDateTimeUTC string<date-time>
vehicleId stringnullable
enforceWorkingHours boolean
state integer<int32>

Possible values: [0, 1]

foundWorkingHours object
workingHourBasedOn stringnullable
driverId stringnullable
vehicleId stringnullable
tenantId stringnullable
timeZone stringnullable
days object[]nullable
  • Array [
  • day stringnullable
    start stringnullable
    end stringnullable
    lunch stringnullable
    lunchEnd stringnullable
    enabled boolean
    lunchEnabled boolean
  • ]
  • driverId string<uuid>nullable
    allowedPointToleraceMeters integer<int32>nullable
    defaultAverageSpeedKmph integer<int32>nullable
    endOn integer<int32>

    Possible values: [0, 1, 2]

    optimize integer<int32>

    Possible values: [0, 1, 2]

    toleranceMinutes integer<int32>nullable
    toleranceMeters integer<int32>nullable
    route object
    existingRouteName stringnullable
    routeData object
    routeName stringnullable
    description stringnullable
    routePoints object[]nullable
  • Array [
  • sequence integer<int32>
    pointType integer<int32>

    Possible values: [0, 1, 2, 3, 4, 5]

    minutes_at_location integer<int32>
    locationName stringnullable
    averageSpeedKmph integer<int32>nullable
    latitude number<double>nullable
    longitude number<double>nullable
    extraDetail object
    name stringnullable
    description stringnullable
    customer stringnullable
    documentNo stringnullable
    contactName stringnullable
    contactNumber stringnullable
    toleranceMeters integer<int32>nullable
    requireSignature booleannullable
    requirePhoto booleannullable
    resolvedLocation object
    id stringnullable
    tenantId stringnullable
    position object
    latitude number<double>required
    longitude number<double>required
    type stringnullable
    name stringrequired

    Possible values: <= 255 characters

    tolerance integer<int32>required
    tag stringrequired

    Possible values: <= 255 characters

    polyPoints object[]nullable
  • Array [
  • latitude number<double>required
    longitude number<double>required
  • ]
  • radius integer<int32>nullable
    geoZone stringnullable
    category stringnullable
    userType stringnullable
    contactID stringnullable
    contactName stringnullable
    contactNumber stringnullable
    contactEmail stringnullable
    address stringnullable
    addressCity stringnullable
    addressState stringnullable
    addressCountry stringnullable
    description stringnullable
  • ]
  • foundRouteId stringnullable
    testOnly boolean
    RSImportRequest
    {
    "toImport": {},
    "testOnly": true
    }