How to get a MPI
This document is designed to help you understand how you can fetch a MPI. To get a mpi, you first need your credentials.If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us. The endpoint mentioned below can help you with getting a mpi -
- Parameters Used:
{{dealerDepartmentUuid}}- UUID of the department you want to fetch MPI from{{orderUUID}}- UUID of the order you want to fetch{{mpiUUID}}- UUID of the multipoint inspection you want to fetch{{basic_auth_token}}- Authorization: Basic "generate using username password"
Scope: The service subscriber needs to have the following scope for the department in the request -
multipoint.inspection.fetchEndpoint
curl -X GET "https://api.mykaarma.com/scprocessor/mpi/v1/dealerDepartment/{{dealerDepartmentUuid}}/order/{{orderUUID}}/multiPointInspection/{{mpiUUID}}"
-H "accept: application/json"
-H "authorization: {{basic_auth_token}}"
"
- Response
{
"errors": [
{
"errorCode": "string",
"errorDescription": "string",
"errorUID": "string"
}
],
"multiPointInsepction": MultiPointInsepction,
"statusCode": integer,
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
]
}
- Quick summary of how to get to details of recommendations:
- The multiPointInsepction (please maintain the typo, apologies) object in the response has multiple sections such brakes, tires etc and the section can be identified using the property name under sections.
- Each section has multiple checks associated with it such as alignment check, Tires condition check under the Tires section again identified by property name under section->check.
- Each check may or may not have a recommendation association with it under the property name recommendations.
- The approvalState property of individual recommendations may be approved or declined which suggests the decision by the customer for the recommendation.
MultiPointInsepction Object
{
{
"allowedRecommendationWorkStatuses": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"approvedTotal": 0,
"assignees": [
{
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
}
],
"attachments": [
{
"audioUrl": "string",
"captionsUrl": "string",
"createdOn": "date",
"hasAudio": "string",
"info": "string",
"link": "string",
"source": "string",
"type": "string",
"updatedOn": "date",
"uuid": "string",
"videoLength": 0,
"visibility": "string"
}
],
"createdOn": "date",
"customerIdentifiers": {
"company": "string",
"customerKey": "string",
"customerName": "string",
"customerUUID": "string",
"isBuisness": true
},
"dealerAssociateIdentifiers": {
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
},
"dealerDepartmentUUID": "string",
"dealerIdentifiers": {
"dealerName": "string",
"dealerPhoneNumber": "string",
"dealerUUID": "string"
},
"fieldOptionsMapping": [
{
"fieldType": "string",
"options": [
{
"sortOrder": 0,
"state": "string",
"value": "string"
}
]
}
],
"inspectionTypeUuid": "string",
"labels": [
"string"
],
"mpiCounts": {
"approveCount": 0,
"completeCount": 0,
"declineCount": 0,
"laborIncompleteCount": 0,
"laborRequestedCount": 0,
"notNeededCount": 0,
"partsIncompleteCount": 0,
"partsPendingSaleCount": 0,
"partsRequestedCount": 0,
"populatedByPartners": [
"string"
],
"requiredChecksUnfilledCount": 0,
"totalManualImageCount": 0,
"totalManualVideoCount": 0,
"totalRecommendationCount": 0
},
"mpiFlags": {
"autoSendFailureDescription": "string",
"customerNotifiedByEmailOn": "date",
"customerNotifiedByTextOn": "date",
"isComplete": true,
"isNotNeeded": true,
"mode": "FULL_MPI",
"sentMedium": "string",
"sentStatus": "string",
"sentToCustomerOn": "date",
"sentToName": "string",
"sentToNumber": "string",
"uploadedMediaCount": 0,
"version": 0
},
"mpiSecondaryFlags": {
"captionsRequested": true,
"customerLinkViewCount": 0,
"customerSeenOn": "date",
"estimateOverDue": true,
"isRequestedFullMPI": true,
"isfeedbackDone": true,
"mediaUploadStatus": "string",
"sendToCustomerOverDue": true,
"statusOverDue": true,
"videoOnlySendFailureDescription": "string",
"videoOnlySentMedium": "string",
"videoOnlySentStatus": "string",
"videoOnlySentToCustomerOn": "date",
"videoOnlySentToName": "string",
"videoOnlySentToNumber": "string",
"videoOnlyViewCount": 0
},
"mpiSections": [
{
"checks": [
{
"attachments": [
{
"audioUrl": "string",
"captionsUrl": "string",
"createdOn": "date",
"hasAudio": "string",
"info": "string",
"link": "string",
"source": "string",
"type": "string",
"updatedOn": "date",
"uuid": "string",
"videoLength": 0,
"visibility": "string"
}
],
"createdOn": "date",
"description": "string",
"dmsLaborType": "string",
"fieldList": [
{
"description": "string",
"sortOrder": "string",
"state": "string",
"type": "string",
"unit": "string",
"value": "string"
}
],
"inspectionState": {
"isEligibleToSkip": true,
"isSkipped": true
},
"isCustom": true,
"isEstimateRequired": true,
"isRequired": true,
"isSafetyQuestion": true,
"isValid": true,
"laborOpCode": "string",
"laborType": "string",
"laborTypeCustomerText": "string",
"lastUpdatedBy": {
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
},
"name": "string",
"notes": "string",
"originalLaborCost": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"originalPartsCost": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"originalShopFees": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"originalTax": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"originalTotal": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"pdrUuid": "string",
"populatedByPartner": "string",
"recommendations": [
{
"amount": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"approvalReason": "string",
"approvalState": "string",
"attachments": [
{
"audioUrl": "string",
"captionsUrl": "string",
"createdOn": "date",
"hasAudio": "string",
"info": "string",
"link": "string",
"source": "string",
"type": "string",
"updatedOn": "date",
"uuid": "string",
"videoLength": 0,
"visibility": "string"
}
],
"createdOn": "date",
"defaultPartsPriceEtaStatus": "string",
"description": "string",
"discount": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"externalEstimator": {
"daUuid": "string",
"departmentUuid": "string",
"fName": "string",
"lName": "string",
"role": "string"
},
"hasShopFees": true,
"hasTax": true,
"isApprovedDeclinedByDealerAssociate": true,
"isCustom": true,
"isDefaultPartsPriceAvailable": true,
"isEstimateHidden": true,
"isEstimateRequired": true,
"isPartsAddedToDms": true,
"isPartsNeeded": true,
"isRequested": true,
"isValid": true,
"laborHours": 0,
"laborPricing": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"laborType": "string",
"lastUpdatedBy": {
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
},
"miscAmount": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"note": "string",
"opCodes": [
"string"
],
"parts": [
{
"addedToServiceLine": true,
"binLocation": "string",
"corePrice": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"description": "string",
"eta": "date",
"etaStatus": "string",
"isAvailable": true,
"mfrCode": "string",
"name": "string",
"number": "string",
"onHoldQuantity": 0,
"price": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"quantity": 0,
"splStatusStr": "string",
"status": "string"
}
],
"partsInfo": "string",
"partsPricing": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"serviceType": "string",
"shopFees": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"showZeroEstimateToCustomer": true,
"status": "string",
"tax": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"updatedOn": "date",
"uuid": "string",
"version": 0,
"workStatus": "string"
}
],
"serviceLineDetails": {
"comebackFlag": true,
"completeErrorMessageFromDms": "string",
"counterPerson": {
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
},
"dispatchCode": "string",
"errorDescription": "string",
"estimatedDuration": 0,
"fortellisRequestId": "string",
"fortellisSubscriptionId": "string",
"isPricingFetchedFromOpcodeOnce": true,
"jobIdentifier": "string",
"jobNumber": "string",
"opCode": "string",
"opCodeDescription": "string",
"opCodeFromMpiTemplate": "string",
"originalJobNumber": "string",
"pushStatus": "string",
"pushStatusUpdateTs": "date",
"retryAttempts": 0
},
"sortOrder": 0,
"totalApproved": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"type": "string",
"updatedOn": "date",
"uuid": "string",
"version": 0
}
],
"description": "string",
"isValid": true,
"name": "string",
"sortOrder": 0,
"type": "string",
"uuid": "string",
"version": 0
}
],
"ocrList": [
"string"
],
"orderDetails": {
"promiseDate": "string",
"promiseTime": "string"
},
"orderIdentifiers": {
"dmsStatus": "string",
"isWaiter": true,
"orderDate": "string",
"orderNumber": "string",
"orderStatus": "string",
"orderUUID": "string",
"originalEstimate": "string",
"tagNumber": "string"
},
"partsRepresentativeIdentifiers": {
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
},
"populatedByPartners": [
"string"
],
"recommendedTotal": 0,
"shopFeesAndTaxSettings": {
"applyTaxToShopFees": true,
"maxShopFees": 0,
"minShopFees": 0,
"shopFeesLaborPercentage": 0,
"shopFeesPartsPercentage": 0,
"shopfeesAlias": "string",
"taxLaborPercentage": 0,
"taxPartsPercentage": 0
},
"status": "string",
"statusUpdatedOn": "date",
"technicianIdentifiers": [
{
"dealerAssociateName": "string",
"dealerAssociateUUID": "string"
}
],
"totalPrices": {
"approvedOriginalRecommendedTotal": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"approvedOtherRecommendedTotal": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"approvedTotal": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"originalTotal": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"shopFees": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"totalCost": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
},
"totalTax": {
"amount": 0,
"createdOn": "date",
"unit": "string",
"updatedOn": "date"
}
},
"type": "string",
"updatedOn": "date",
"uuid": "string",
"vehicleIdentifiers": {
"estimatedMileage": "string",
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleUUID": "string",
"vehicleYear": "string",
"vin": "string"
},
"version": 0,
"workflowDetails": {
"currentNodeUuid": "string",
"executedEvents": [
{
"affectedDealerAssociateUuids": [
"string"
],
"checkUuid": "string",
"eventName": "string"
}
],
"pendingEvents": [
{
"affectedDealerAssociateUuids": [
"string"
],
"checkUuid": "string",
"eventName": "string"
}
],
"version": 0,
"workflowUuid": "string"
}
}
}