Skip to main content

RSImportResponse

importResults objectnullable
property name* RSImportResultRecord
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
    success boolean
    messages string[]nullable
    jobs objectnullable
    property name* Job
    id string<uuid>
    origAncestorId string<uuid>nullable
    lastAncestorId string<uuid>nullable
    docType integer<int32>

    Possible values: [0, 1, 2]

    name stringnullable
    customer stringnullable
    docReference stringnullable
    jobType stringnullable
    description stringnullable
    stayTimeMinutes integer<int32>
    location object
    id stringnullable
    name stringnullable
    address stringnullable
    contactName stringnullable
    contactNumber stringnullable
    latitude number<double>
    longitude number<double>
    toleranceMeters number<double>
    jobDate string<date-time>
    preferredFromTimeUTC string<date-time>nullable
    preferredToTimeUTC string<date-time>nullable
    driverId string<uuid>nullable
    vehicleId stringnullable
    requiredSkill string[]nullable
    recurring object
    range object
    startFromUTC string<date-time>nullable
    endOnUTC string<date-time>nullable
    numberOfTimes integer<int32>nullable
    status integer<int32>

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

    notifications object
    remindMinutesBefore integer<int32>[]nullable
    jobInstanceOrderDetailMetrics object[]nullable
  • Array [
  • lineNumber integer<int32>
    description stringnullable
    type integer<int32>

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

    isRequired boolean
    unitOfMeasurement stringnullable
    currency stringnullable
    value stringnullable
    driverInputRequired boolean
  • ]
  • jobInstanceDeliveryMetrics object[]nullable
  • Array [
  • lineNumber integer<int32>
    description stringnullable
    type integer<int32>

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

    isRequired boolean
    unitOfMeasurement stringnullable
    currency stringnullable
    value stringnullable
  • ]
  • tenant stringnullable
    scheduleId string<uuid>nullable
    reqSign booleannullable
    reqPhoto booleannullable
    createdDateUTC string<date-time>
    watchers object[]nullable
  • Array [
  • name stringnullable
    cell stringnullable
    email stringnullable
  • ]
  • pointPolyLongLat stringnullable
    driverDataBackup object
    name stringnullable
    surname stringnullable
    displayName stringnullable
    mobile stringnullable
    isReadOnly booleannullable
    instanceType integer<int32>

    Possible values: [0, 1]

    lastCompletedDateUTC string<date-time>nullable
    recurredToId string<uuid>nullable
    history object[]nullable
  • Array [
  • userId string<uuid>
    status integer<int32>

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

    dateTimeUTC string<date-time>
    comment stringnullable
  • ]
  • actualArrivalUTC string<date-time>nullable
    actualStayTimeMinutes integer<int32>nullable
    distanceCoveredMeter integer<int64>nullable
    attachments object[]nullable
  • Array [
  • type integer<int32>

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

    fileName stringnullable
    urlId stringnullable
    size integer<int64>nullable
  • ]
  • theSchedule object
    tenantId stringnullable
    scheduleId stringnullable
    documentType stringnullable
    assignedAssetId stringnullable
    assignedOperatorId stringnullable
    schedulePlannedStartDateTime integer<int64>
    schedulePlannedEndDateTime integer<int64>
    scheduleActualStartDateTime integer<int64>
    scheduleActualEndDateTime integer<int64>
    averageSpeed number<double>
    startLocationType stringnullable
    startLocationId stringnullable
    startLocationName stringnullable
    startLocationLongLat stringnullable
    endLocationType stringnullable
    endLocationId stringnullable
    endLocationName stringnullable
    endLocationLongLat stringnullable
    endOn stringnullable
    scheduleStatus stringnullable
    scheduleOptimization stringnullable
    routeId stringnullable
    scheduleToleranceMinutes integer<int64>
    estimateOffsetMinutes integer<int64>
    latestVehiclePosition object
    eventMessageTenantTimezone stringnullable
    eventMessageEventId stringnullable
    eventMessageTenantID stringnullable
    eventMessageUserID stringnullable
    deviceId stringnullable
    tripId integer<int64>
    longitude number<double>
    latitude number<double>
    altitude integer<int64>
    speed integer<int64>
    heading integer<int64>
    deltaOdo integer<int64>
    runningOdo integer<int64>
    dateTimeUtc string<date-time>
    positionAccuracy integer<int64>
    orientationStatus integer<int64>
    accelerometerValueX integer<int64>
    maxSpeed integer<int64>
    tripStartDateUtc string<date-time>
    eventId integer<int64>
    statuses stringnullable
    baseGeneratedStatuses stringnullable
    positionType integer<int64>
    alarmFlags integer<int64>
    singleStatus integer<int32>
    statusText stringnullable
    attributeTypeId integer<int64>
    additionalFlags integer<int64>
    driverTag stringnullable
    driverId stringnullable
    vehicleId stringnullable
    areaIds object
    masks string<byte>nullable
    areaNodeIds integer<int32>[]nullable
    eventIds string<byte>nullable
    priority integer<int64>
    accelerometerValueY integer<int64>
    speedSource integer<int64>
    trailerTags string[]nullable
    maxAcceleromterValueX integer<int64>
    maxAcceleromterValueY integer<int64>
    accelerometerViolationCount integer<int64>
    reverseGeocoding object
    address object
    country stringnullable
    state stringnullable
    county stringnullable
    city stringnullable
    district stringnullable
    street stringnullable
    housenumber stringnullable
    postalcode stringnullable
    functionalclass stringnullable
    streetlimit number<double>
    offRouteLegs string[]nullable
    routeDeviationMeters integer<int32>
    scheduleRouteToleranceMeters integer<int32>
    isSequenceViolated boolean
    routeHandle stringnullable
    driverDataBackup object
    name stringnullable
    surname stringnullable
    displayName stringnullable
    mobile stringnullable
    enforceWorkingHours boolean
    workingHours 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
  • ]
  • overlaps object[]nullable
  • Array [
  • tenantId stringnullable
    scheduleId stringnullable
    documentType stringnullable
    assignedAssetId stringnullable
    assignedOperatorId stringnullable
    schedulePlannedStartDateTime integer<int64>
    schedulePlannedEndDateTime integer<int64>
    scheduleActualStartDateTime integer<int64>
    scheduleActualEndDateTime integer<int64>
    averageSpeed number<double>
    startLocationType stringnullable
    startLocationId stringnullable
    startLocationName stringnullable
    startLocationLongLat stringnullable
    endLocationType stringnullable
    endLocationId stringnullable
    endLocationName stringnullable
    endLocationLongLat stringnullable
    endOn stringnullable
    scheduleStatus stringnullable
    scheduleOptimization stringnullable
    routeId stringnullable
    scheduleToleranceMinutes integer<int64>
    estimateOffsetMinutes integer<int64>
    latestVehiclePosition object
    eventMessageTenantTimezone stringnullable
    eventMessageEventId stringnullable
    eventMessageTenantID stringnullable
    eventMessageUserID stringnullable
    deviceId stringnullable
    tripId integer<int64>
    longitude number<double>
    latitude number<double>
    altitude integer<int64>
    speed integer<int64>
    heading integer<int64>
    deltaOdo integer<int64>
    runningOdo integer<int64>
    dateTimeUtc string<date-time>
    positionAccuracy integer<int64>
    orientationStatus integer<int64>
    accelerometerValueX integer<int64>
    maxSpeed integer<int64>
    tripStartDateUtc string<date-time>
    eventId integer<int64>
    statuses stringnullable
    baseGeneratedStatuses stringnullable
    positionType integer<int64>
    alarmFlags integer<int64>
    singleStatus integer<int32>
    statusText stringnullable
    attributeTypeId integer<int64>
    additionalFlags integer<int64>
    driverTag stringnullable
    driverId stringnullable
    vehicleId stringnullable
    areaIds object
    masks string<byte>nullable
    areaNodeIds integer<int32>[]nullable
    eventIds string<byte>nullable
    priority integer<int64>
    accelerometerValueY integer<int64>
    speedSource integer<int64>
    trailerTags string[]nullable
    maxAcceleromterValueX integer<int64>
    maxAcceleromterValueY integer<int64>
    accelerometerViolationCount integer<int64>
    reverseGeocoding object
    address object
    country stringnullable
    state stringnullable
    county stringnullable
    city stringnullable
    district stringnullable
    street stringnullable
    housenumber stringnullable
    postalcode stringnullable
    functionalclass stringnullable
    streetlimit number<double>
    offRouteLegs string[]nullable
    routeDeviationMeters integer<int32>
    scheduleRouteToleranceMeters integer<int32>
    isSequenceViolated boolean
    routeHandle stringnullable
    driverDataBackup object
    name stringnullable
    surname stringnullable
    displayName stringnullable
    mobile stringnullable
    enforceWorkingHours boolean
    workingHours 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
  • ]
  • ]
  • RSImportResponse
    {
    "importResults": {}
    }