Este conjunto de endpoints permite consultar o histórico de manutenções realizadas em um veículo, visualizar os detalhes de cada ordem de serviço e gerar um relatório consolidado das manutenções executadas.

Funcionalidades Principais

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

Consultar histórico de manutenção do veículo
Consultar detalhes do histórico de manutenção
Gerar relatório do histórico de manutenção

Consultar histórico de manutenção do veículo

Retorna uma lista paginada com o histórico de manutenções realizadas para o veículo informado.

Endpoint: /api/vehicles/{id}/maintenance-history

Método: GET

Parâmetros:

id (path, obrigatório, integer) — Identificador do veículo.
filterDTO (query, obrigatório, tipo não especificado)
page (query, obrigatório, tipo não especificado)

Request payload:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "requestId": "string",
      "periodServiceCompleted": "2024-01-01T00:00:00Z",
      "endedIn": "2024-01-01T00:00:00Z",
      "currentKm": 0,
      "carWorkshop": "string",
      "carWorkshopId": 0,
      "serviceType": "string"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

Consultar detalhes do histórico de manutenção

Retorna os itens registrados em uma ordem de serviço pertencente ao histórico de manutenção do veículo.

Endpoint: /api/vehicles/{id}/maintenance-history/{serviceRequestId}

Método: GET

Parâmetros:

id (path, obrigatório, integer) — Identificador do veículo.
serviceRequestId (path, obrigatório, integer) — Identificador da ordem de serviço.
filterDTO (query, obrigatório, tipo não especificado)

Request payload:

[
  {
    "id": 0,
    "requestId": "string",
    "itemType": "string",
    "name": "string",
    "manufacturerName": "string",
    "code": "string",
    "amount": 0,
    "measurementUnit": "string",
    "carWorkshopPrice": 0,
    "clientPrice": 0
  }
]

Gerar relatório do histórico de manutenção

Retorna um relatório consolidado contendo o histórico de manutenções do veículo, organizado por categoria de serviço.

Endpoint: /api/vehicles/{id}/maintenance-history/report

Método: GET

Parâmetros:

id (path, obrigatório, integer) — Identificador do veículo.
filterDTO (query, obrigatório, tipo não especificado)

Request payload:

{
  "vehicle": {
    "licensePlate": "string",
    "model": "string",
    "chassis": "string",
    "clientName": "string",
    "block": "string",
    "registrationDate": "2024-01-01T00:00:00Z",
    "reportDate": "2024-01-01T00:00:00Z"
  },
  "preventives": {
    "maintenancesFinished": 0,
    "totalAmount": 0,
    "averageTicket": 0,
    "serviceRequests": [
      {
        "requestId": null,
        "executionDate": null,
        "finishedDate": null,
        "carWorkshop": null,
        "currentKm": null,
        "services": null,
        "parts": null
      }
    ]
  },
  "correctives": {
    "maintenancesFinished": 0,
    "totalAmount": 0,
    "averageTicket": 0,
    "serviceRequests": [
      {
        "requestId": null,
        "executionDate": null,
        "finishedDate": null,
        "carWorkshop": null,
        "currentKm": null,
        "services": null,
        "parts": null
      }
    ]
  },
  "tires": {
    "maintenancesFinished": 0,
    "totalAmount": 0,
    "averageTicket": 0,
    "serviceRequests": [
      {
        "requestId": null,
        "executionDate": null,
        "finishedDate": null,
        "carWorkshop": null,
        "currentKm": null,
        "services": null,
        "parts": null
      }
    ]
  },
  "glasses": {
    "maintenancesFinished": 0,
    "totalAmount": 0,
    "averageTicket": 0,
    "serviceRequests": [
      {
        "requestId": null,
        "executionDate": null,
        "finishedDate": null,
        "carWorkshop": null,
        "currentKm": null,
        "services": null,
        "parts": null
      }
    ]
  }
}