Este módulo permite consultar os planos de manutenção cadastrados para veículos e modelos, além de pesquisar tarefas e frequências de manutenção.

Funcionalidades Principais

Abaixo estão os atalhos para as operações mais utilizadas neste módulo:

Buscar plano de manutenção por veículo
Listar tarefas do plano de manutenção
Consultar frequências de manutenção
Pesquisar planos de manutenção

Buscar plano de manutenção por veículo

Retorna o plano de manutenção associado a um veículo específico.

Endpoint: /api/maintenance-plans/vehicle/{vehicleId}

Método: GET

Parâmetros:

vehicleId (path, obrigatório) — Identificador do veículo.

Response body:

{
  "id": 0,
  "kmInterval": 0,
  "timeInterval": 0,
  "modelId": 0,
  "clientId": 0,
  "currencyId": 0,
  "client": {
    "id": 0,
    "clientCode": "string",
    "sapId": "string",
    "corporateName": "string",
    "tradingName": "string",
    "taxIdentifier": "string",
    "isParent": true,
    "clientType": "DEFAULT",
    "negotiationId": 0
  },
  "model": {
    "id": 0,
    "motor": "string",
    "version": "string",
    "initialYear": 0,
    "endYear": 0,
    "brandId": 0,
    "brandName": "string",
    "description": "string",
    "countryId": 0,
    "countryName": "string",
    "displayName": "string",
    "haveMaintenancePlan": true,
    "havePriceTable": true,
    "category": "RIDE"
  },
  "isPuc": true,
  "carWorkshopCategory": "INDEPENDENT",
  "contractParameterizationId": 0
}

Listar tarefas do plano de manutenção

Retorna todas as tarefas previstas no plano de manutenção de um veículo.

Endpoint: /api/maintenance-plans/vehicle/{vehicleId}/tasks

Método: GET

Parâmetros:

vehicleId (path, obrigatório) — Identificador do veículo.

Response body:

[
  {
    "id": 0,
    "maintenancePlanId": 0,
    "timeFrequency": 0,
    "maintenancePlanTaskFrequencies": [
      {
        "id": 0,
        "maintenancePlanTaskId": 0,
        "kmFrequency": 0
      }
    ],
    "taskType": "string",
    "name": "string",
    "partAmount": 0,
    "serviceId": 0,
    "clientServicePrice": 0,
    "carWorkshopServicePrice": 0,
    "partId": 0,
    "partCategoryId": 0,
    "clientPartPrice": 0,
    "carWorkshopPartPrice": 0,
    "indicativePriceServiceId": 0
  }
]

Consultar frequências de manutenção

Retorna as frequências de manutenção configuradas para um modelo e cliente.

Endpoint: /api/maintenance-plans/frequency

Método: GET

Parâmetros:

modelId (query, obrigatório) — Identificador do modelo.
clientId (query, obrigatório) — Identificador do cliente.

Response body:

{
  "id": 0,
  "model": {
    "id": 0,
    "motor": "string",
    "version": "string",
    "initialYear": 0,
    "endYear": 0,
    "brandId": 0,
    "brandName": "string",
    "description": "string",
    "countryId": 0,
    "countryName": "string",
    "displayName": "string",
    "haveMaintenancePlan": true,
    "havePriceTable": true,
    "category": "RIDE"
  },
  "frequencies": [
    0
  ],
  "isPuc": true
}

Pesquisar planos de manutenção

Pesquise planos de manutenção utilizando os filtros informados.

Endpoint: /api/maintenance-plans/filters

Método: GET

Parâmetros:

filterDTO (query, obrigatório) — Filtros utilizados na pesquisa dos planos de manutenção.
page (query, obrigatório) — Informações de paginação.

Response body: Retorna uma lista paginada de planos de manutenção.

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "kmInterval": 0,
      "timeInterval": 0,
      "modelId": 0,
      "clientId": 0,
      "currencyId": 0,
      "client": {
        "id": null,
        "corporateName": null,
        "tradingName": null
      },
      "model": {
        "id": null,
        "brandName": null,
        "description": null,
        "displayName": null,
        "category": null
      },
      "isPuc": true,
      "carWorkshopCategory": "INDEPENDENT",
      "contractParameterizationId": 0
    }
  ],
  "number": 0,
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}