getLoanersList

getLoanersList

Header Parameters

authorization string required

authorization

application/json

Request Body required

getLoanerVehiclesByFilterRequest

dealerDepartmentUUIDList string[]
dealerIDList int64[]
dealerUuidList string[]
loanerStatusList string[]

Possible values: [AVAILABLE, CHECKED_OUT, RESERVED]

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
loanerList object[]
Array [
addedDate string
body string
color string
dealerLoanerVehicleList object[]
Array [
dealerAssociateUUID string
dealerDepartmentUUID string
dealerName string
dealerUUID string
id int64
uuid string
]
description string
engine string
isValid boolean
latestMileage string
licensePlate string
licenseStateCode string
loanerKey string
loanerStatus string
Possible values: [AVAILABLE, CHECKED_OUT, RESERVED]
make string
model string
name string
updatedDate string
vin string
year string
]
statusCode int32
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string",
    "metadata": {}
  },
  "loanerList": [
    {
      "addedDate": "string",
      "body": "string",
      "color": "string",
      "dealerLoanerVehicleList": [
        {
          "dealerAssociateUUID": "string",
          "dealerDepartmentUUID": "string",
          "dealerName": "string",
          "dealerUUID": "string",
          "id": 0,
          "uuid": "string"
        }
      ],
      "description": "string",
      "engine": "string",
      "isValid": true,
      "latestMileage": "string",
      "licensePlate": "string",
      "licenseStateCode": "string",
      "loanerKey": "string",
      "loanerStatus": "AVAILABLE",
      "make": "string",
      "model": "string",
      "name": "string",
      "updatedDate": "string",
      "vin": "string",
      "year": "string"
    }
  ],
  "statusCode": 0,
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/loaners

Request

Base URL

//api.mykaarma.com/pickupdelivery

authorization — header required

Body required

{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "dealerIDList": [
    0
  ],
  "dealerUuidList": [
    "string"
  ],
  "loanerStatusList": [
    "AVAILABLE"
  ],
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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

ruby / Net::HTTP

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

csharp / RestSharp

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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