findUserToRouteCall

findUserToRouteCall

application/json

Request Body required

callRequest

brokerNumber string
callerDA object

departmentUuid string

Unique department identifier for user, not mandatory

name string

name of the user

type string

Possible values: [USER, CUSTOMER]

Types of users of mykaarma USER/CUSTOMER

uuid string

Unique identifier for the user of mykaarma

callerNumber string
dealerUUID string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

*/*

Schema

Example (from schema)

---

Schema

calleeDA object

departmentUuid string

Unique department identifier for user, not mandatory

name string

name of the user

type string

Possible values: [USER, CUSTOMER]

Types of users of mykaarma USER/CUSTOMER

uuid string

Unique identifier for the user of mykaarma

customerUUID string
errors object[]
Array [
errorCode string
errorDescription string
metadata object
property name* string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "calleeDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/route/internal/call

Request

Base URL

//api.mykaarma.com/pickupdelivery

Body required

{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/route/internal/call' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "brokerNumber": "string",
  "callerDA": {
    "departmentUuid": "string",
    "name": "string",
    "type": "USER",
    "uuid": "string"
  },
  "callerNumber": "string",
  "dealerUUID": "string"
}'