getDriversList

getDriversList

Header Parameters

authorization string required

authorization

application/json

Request Body required

getDriverListRequest

dealerDepartmentUUIDList 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

driverUserList object[]
Array [
cellPhone string
dealerMappingList object[]
Array [
associateDmsId string
dealerName string
dealerUUID string
departmentUUID string
driverId int64
driverUUID string
isValid boolean
password string
]
emailAddress string
emailSignature string
firstName string
imageUrl string
ipadClientName string
lastName string
nickname string
phone string
textNumber string
userInviteStatus string
userUUID string
]
error object
errorCode string
errorDescription string
metadata object
property name* string
statusCode int32
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "driverUserList": [
    {
      "cellPhone": "string",
      "dealerMappingList": [
        {
          "associateDmsId": "string",
          "dealerName": "string",
          "dealerUUID": "string",
          "departmentUUID": "string",
          "driverId": 0,
          "driverUUID": "string",
          "isValid": true,
          "password": "string"
        }
      ],
      "emailAddress": "string",
      "emailSignature": "string",
      "firstName": "string",
      "imageUrl": "string",
      "ipadClientName": "string",
      "lastName": "string",
      "nickname": "string",
      "phone": "string",
      "textNumber": "string",
      "userInviteStatus": "string",
      "userUUID": "string"
    }
  ],
  "error": {
    "errorCode": "string",
    "errorDescription": "string",
    "metadata": {}
  },
  "statusCode": 0,
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/driver/list

Request

Base URL

//api.mykaarma.com/pickupdelivery

authorization — header required

Body required

{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/driver/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'