Log actions during a trip.

End-point to log different actions like - START DRIVING, IN-PROGRESS, AT DESTINATION, COMPLETED, CANCEL for a trip. These actions are required to track progress of a trip. Each actions is tagged with location coordinates.

Path Parameters

tripUUID string required

Unique identifier for a trip

action string required

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

Action to be logged

Header Parameters

authorization string required

Base64 encoded basic auth

application/json

Request Body required

Log action request

dealerDepartmentUUIDList string[]
departmentUUID string
pickupDeliveryAction object
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

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
metadata object
property name* string
statusCode int32
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string",
    "metadata": {}
  },
  "statusCode": 0,
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/trip/:tripUUID/action/:action/log

Request

Base URL

//api.mykaarma.com/pickupdelivery

tripUUID — path required

action — path required

---STARTSTART_DRIVINGIN_PROGRESSNEARBYEND_DRIVINGAT_DESTINATIONCOMPLETECANCEL

authorization — header required

Body required

{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "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/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:tripUUID/action/:action/log' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "departmentUUID": "string",
  "pickupDeliveryAction": {
    "actionTimeStamp": "string",
    "altitude": 0,
    "driverUUID": "string",
    "locationLat": 0,
    "locationLon": 0,
    "orientation": 0,
    "speed": 0,
    "subTripUUID": "string"
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'