Skip to main content

Log offline actions for a trip.

End-point to log actions and locations data saved in offline mode on mobile device. This end-point could also be used to send bulk data for a trip.

Path Parameters
    tripUUID string required

    Unique identifier for a trip

Header Parameters
    authorization string required

    Base64 encoded basic auth

Request Body required

Log offline actions request

    dealerDepartmentUUIDList string[]
    departmentUUID string
    logActions object[]
  • Array [
  • action string

    Possible values: [START, START_DRIVING, IN_PROGRESS, NEARBY, END_DRIVING, AT_DESTINATION, COMPLETE, CANCEL]

    actionTimeStamp string
    altitude double
    driverUUID string
    locationLat double
    locationLon double
    orientation double
    speed double
    subTripUUID string
  • ]
  • requesterUserUUID string
    source string

    Possible values: [DEALER_APP, WEB, PND_API, EXTERNAL_CONTROLLER]

Responses

OK


Schema
    error object
    errorCode string
    errorDescription string
    metadata object
    property name* string
    statusCode int32
    warnings object[]
  • Array [
  • warningCode string
    warningDescription string
  • ]
POST /v3/trip/:tripUUID/offline/log

Request

Base URL
//api.mykaarma.com/pickupdelivery
tripUUID — path required
authorization — header required
Body required
{
"dealerDepartmentUUIDList": [
"string"
],
"departmentUUID": "string",
"logActions": [
{
"action": "START",
"actionTimeStamp": "string",
"altitude": 0,
"driverUUID": "string",
"locationLat": 0,
"locationLon": 0,
"orientation": 0,
"speed": 0,
"subTripUUID": "string"
}
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}
curl / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/offline/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"departmentUUID": "string",
"logActions": [
{
"action": "START",
"actionTimeStamp": "string",
"altitude": 0,
"driverUUID": "string",
"locationLat": 0,
"locationLon": 0,
"orientation": 0,
"speed": 0,
"subTripUUID": "string"
}
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'