Map trip and internal note

End-point to map a trip with an internal note. Identifiers passed in this end-point are mapped to each other. Pass these carefully else wrong internal note could be mapped to a trip.

Header Parameters

authorization string required

Base64 encoded basic auth

application/json

Request Body required

Request to map trip with internal note

customerUUID string
errors object[]
Array [
errorCode string
errorDescription string
metadata object
property name* string
]
messageUUID string
metaData object
property name* string
requestUUID string
status string

Possible values: [SUCCESS, FAILURE]

warnings object[]
Array [
warningCode string
warningDescription string
]

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
messageUuid string
status boolean
statusCode int32
tripUuid string
warnings object[]
Array [
warningCode string
warningDescription string
]

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

Created

Unauthorized

Forbidden

Not Found

POST /v3/trip/internalnote/mapping

Request

Base URL

//api.mykaarma.com/pickupdelivery

authorization — header required

Body required

{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/internalnote/mapping' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerUUID": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "metadata": {}
    }
  ],
  "messageUUID": "string",
  "metaData": {},
  "requestUUID": "string",
  "status": "SUCCESS",
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}'