DriveB

24. Modelo

Este módulo permite consultar modelos de veículos cadastrados no sistema, pesquisar modelos utilizando filtros e listar as categorias disponíveis.


Funcionalidades Principais

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


Buscar modelo por ID

Retorna as informações de um modelo específico.

Endpoint: /api/models/{id}

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador do modelo.

Response body:

{
"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"
}

Pesquisar modelos (paginado)

Pesquise modelos utilizando filtros com suporte à paginação.

Endpoint: /api/models/filters

Método: GET

Parâmetros:

  • modelFilterDTO (query, obrigatório) — Filtros utilizados na pesquisa dos modelos.
  • pageable (query, obrigatório) — Informações de paginação.

Response body:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"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"
}
],
"number": 0,
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

Listar categorias de modelos

Retorna todas as categorias de modelos disponíveis no sistema.

Endpoint: /api/models/categories

Método: GET

Response body:

[
{
"name": "string",
"value": "string"
}
]

Listar modelos

Retorna a lista de modelos conforme os filtros informados.

Endpoint: /api/models/

Método: GET

Parâmetros:

  • modelFilterDTO (query, obrigatório) — Filtros utilizados na pesquisa dos modelos.

Response body:

[
{
"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"
}
]