Skip to main content

Fetch all operations and send excel over email​

This function generates an Excel file containing operations data and sends it over email for a specified dealer, with authorization and error handling.

Path Parameters
    dealerUUID string required

    The dealerUUID parameter is a path variable representing the unique identifier of a dealer. It is extracted from the URL path of the request to identify the specific dealer for whom the operations data is being fetched and processed.

Request Body required

The fetchOperationsRequest parameter is a request body object that contains information needed to fetch operations and generate an Excel file to be sent over email. It likely includes details such as filters, sorting criteria, and any other parameters required to retrieve the operations data for the specified dealer.

    requesterUserUUID string
    onlineSchedulerVisibility boolean
    mobileServiceVisibility boolean
    serviceCartVisibility boolean
    dealerAppSchedulerVisibility boolean
    checkInVisibility boolean
    isDefault boolean
    startPosition int32
    endPosition int32
    isLastPage boolean
    resultSize int32
    communicationCodes string[]
    opCodes string[]
    uuidList string[]
    getTotalCount boolean
    getMkAndDmsSimilarOpcodeCount boolean
    searchToken string
    sortPreference string

    Possible values: [OPCODE, NAME, PRICE, SORT_ORDER, _SCORE]

    sortDirection string

    Possible values: [ASCENDING, DESCENDING]

    eventDealerAssociateUuid string
    serviceTypeList string[]

    Possible values: [MAINTENANCE, REPAIR, INSPECT, SERVICE]

    brandIdList int64[] deprecated
    vehicleMakeList string[] deprecated
    brandUuidList string[]
    typeList string[]

    Possible values: [OPCODE, SERVICEMENU, SERVICEMOTORSMAINTENANCEMENU, SERVICEMOTORSLINEITEM, SERVICEMOTORSINDICATOR]

    mileageDTOList object[]
  • Array [
    • startMileage int64
    repeatInterval int64
    endMileage int64
  • ]
    • baseVehicleId int64
    engineId int64
    minPrice double
    maxPrice double
    dmsLaborPriceMismatch boolean
    severityFlag string
    engineList string[]
    modelList string[]
    yearList int32[]
    trimList string[]
    vehicleUuid string
    vin string
    model string
    year string
    make string
Responses

The method generateOperationsExcelAndSendOverEmail is returning a ResponseEntity object with the body containing an ApiResponse object.

Schema
    errors object[]
  • Array [
    • errorName string
    errorMessage string
    errorCode int32
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningTitle string
    warningMessage string
  • ]
    • statusCode int32
    apiRequestId string
POST /v1/dealers/:dealerUUID/operations/searches/async

Authorization

name: basicAuthtype: httpin: headerscheme: basic

Request

Base URL
/opcodes
Username
Password
dealerUUID — path required
Body required
{

  "requesterUserUUID": "string",

  "onlineSchedulerVisibility": true,

  "mobileServiceVisibility": true,

  "serviceCartVisibility": true,

  "dealerAppSchedulerVisibility": true,

  "checkInVisibility": true,

  "isDefault": true,

  "startPosition": 0,

  "endPosition": 0,

  "isLastPage": true,

  "resultSize": 0,

  "communicationCodes": [

    "string"

  ],

  "opCodes": [

    "string"

  ],

  "uuidList": [

    "string"

  ],

  "getTotalCount": true,

  "getMkAndDmsSimilarOpcodeCount": true,

  "searchToken": "string",

  "sortPreference": "OPCODE",

  "sortDirection": "ASCENDING",

  "eventDealerAssociateUuid": "string",

  "serviceTypeList": [

    "MAINTENANCE"

  ],

  "brandUuidList": [

    "string"

  ],

  "typeList": [

    "OPCODE"

  ],

  "mileageDTOList": [

    {

      "startMileage": 0,

      "repeatInterval": 0,

      "endMileage": 0

    }

  ],

  "baseVehicleId": 0,

  "engineId": 0,

  "minPrice": 0,

  "maxPrice": 0,

  "dmsLaborPriceMismatch": true,

  "severityFlag": "string",

  "engineList": [

    "string"

  ],

  "modelList": [

    "string"

  ],

  "yearList": [

    0

  ],

  "trimList": [

    "string"

  ],

  "vehicleUuid": "string",

  "vin": "string",

  "model": "string",

  "year": "string",

  "make": "string"

}
curl / cURL
curl -L -X POST '/opcodes/v1/dealers/:dealerUUID/operations/searches/async' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "requesterUserUUID": "string",
  "onlineSchedulerVisibility": true,
  "mobileServiceVisibility": true,
  "serviceCartVisibility": true,
  "dealerAppSchedulerVisibility": true,
  "checkInVisibility": true,
  "isDefault": true,
  "startPosition": 0,
  "endPosition": 0,
  "isLastPage": true,
  "resultSize": 0,
  "communicationCodes": [
    "string"
  ],
  "opCodes": [
    "string"
  ],
  "uuidList": [
    "string"
  ],
  "getTotalCount": true,
  "getMkAndDmsSimilarOpcodeCount": true,
  "searchToken": "string",
  "sortPreference": "OPCODE",
  "sortDirection": "ASCENDING",
  "eventDealerAssociateUuid": "string",
  "serviceTypeList": [
    "MAINTENANCE"
  ],
  "brandUuidList": [
    "string"
  ],
  "typeList": [
    "OPCODE"
  ],
  "mileageDTOList": [
    {
      "startMileage": 0,
      "repeatInterval": 0,
      "endMileage": 0
    }
  ],
  "baseVehicleId": 0,
  "engineId": 0,
  "minPrice": 0,
  "maxPrice": 0,
  "dmsLaborPriceMismatch": true,
  "severityFlag": "string",
  "engineList": [
    "string"
  ],
  "modelList": [
    "string"
  ],
  "yearList": [
    0
  ],
  "trimList": [
    "string"
  ],
  "vehicleUuid": "string",
  "vin": "string",
  "model": "string",
  "year": "string",
  "make": "string"
}'