DriveB

22. Motorista

Este módulo permite gerenciar os motoristas cadastrados no sistema, incluindo cadastro, edição, exclusão, consulta, importação, exportação, envio de e-mails e associação de veículos.

Buscar motorista por ID

Recupera as informações de um motorista específico.

Endpoint: /api/drivers/{id}

Método: GET

Parâmetros:

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

Response body:

{
"id": 0,
"sub": "string",
"name": "string",
"email": "string",
"username": "string",
"clientId": 0,
"localeId": 0,
"localeCode": "string",
"carWorkshopId": 0,
"type": "string",
"isApprover": true,
"countryCode": "string",
"termsAndConditions": 0,
"franchiseId": "string",
"givenName": "string",
"familyName": "string",
"socialIdentifier": "string",
"telephoneNumber": "string",
"licenseNumber": "string",
"validateDate": "2024-01-01T00:00:00Z",
"licenseCategoryId": 0,
"clientName": "string",
"active": true,
"isServiceRequester": true,
"approvalUser": "APPROVAL_USER_1",
"firstWebAccessDate": "2024-01-01T00:00:00Z",
"firstMobileAccessDate": "2024-01-01T00:00:00Z",
"lastAccessDate": "2024-01-01T00:00:00Z",
"lastAccessPlatform": "WEB",
"vehicleIds": [
0
],
"role": "DRIVER",
"notificationClientId": 0,
"notificationCarWorkshopId": 0,
"notificationDriverIds": [
0
],
"countryCodeFromDatabase": "BR",
"serverUrl": "string",
"external": true
}

Atualizar motorista

Atualiza as informações de um motorista existente.

Endpoint: /api/drivers/{id}

Método: PUT

Parâmetros:

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

Request payload:

{
"id": 0,
"sub": "string",
"name": "string",
"email": "string",
"username": "string",
"clientId": 0,
"localeId": 0,
"localeCode": "string",
"carWorkshopId": 0,
"type": "string",
"isApprover": true,
"countryCode": "string",
"termsAndConditions": 0,
"franchiseId": "string",
"givenName": "string",
"familyName": "string",
"socialIdentifier": "string",
"telephoneNumber": "string",
"licenseNumber": "string",
"validateDate": "2024-01-01T00:00:00Z",
"licenseCategoryId": 0,
"clientName": "string",
"active": true,
"isServiceRequester": true,
"approvalUser": "APPROVAL_USER_1",
"firstWebAccessDate": "2024-01-01T00:00:00Z",
"firstMobileAccessDate": "2024-01-01T00:00:00Z",
"lastAccessDate": "2024-01-01T00:00:00Z",
"lastAccessPlatform": "WEB",
"vehicleIds": [
0
],
"role": "DRIVER",
"notificationClientId": 0,
"notificationCarWorkshopId": 0,
"notificationDriverIds": [
0
],
"countryCodeFromDatabase": "BR",
"serverUrl": "string",
"external": true
}

Response body:

{ ... }
// Estrutura idêntica ao Request payload acima (objeto do motorista atualizado)

Excluir motorista

Remove um motorista do sistema.

Endpoint: /api/drivers/{id}

Método: DELETE

Parâmetros:

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

Response body:

"string"

Cadastrar motorista

Cadastra um novo motorista.

Endpoint: /api/drivers

Método: POST

Request payload:

{ ... }
// Mesma estrutura de objeto de motorista (ver "Buscar motorista por ID")

Response body:

{
"message": "string",
"payLoad": { ... }, // objeto do motorista criado
"warning": true
}

Importar motoristas

Importa uma lista de motoristas a partir de um arquivo.

Endpoint: /api/drivers/import

Método: POST

Response body:

[
"string"
]

Enviar e-mail para motoristas

Envia um e-mail para os motoristas retornados pelos filtros informados.

Endpoint: /api/drivers/email

Método: POST

Parâmetros:

  • driverFilterDTO (query, obrigatório) — Filtros utilizados para selecionar os motoristas.

Request payload:

{
"title": "string",
"subject": "string",
"message": "string",
"listAttachment": [
{
"id": 0,
"fileName": "string",
"base64": "string"
}
]
}

Response body:

[
{
"email": "string",
"username": "string",
"isWhiteLabel": true
}
]

Enviar e-mail para motoristas

Envia um e-mail para os motoristas retornados pelos filtros informados.

Endpoint: /api/drivers/email

Método: POST

Parâmetros:

  • driverFilterDTO (query, obrigatório) — Filtros utilizados para selecionar os motoristas.

Request payload:

{ ... }
// Estrutura idêntica ao endpoint anterior

Response body:

[ ... ]
// Estrutura idêntica ao endpoint anterior

Listar veículos do motorista

Retorna todos os veículos associados a um motorista.

Endpoint: /api/drivers/{driverId}/vehicles

Método: GET

Parâmetros:

  • driverId (path, obrigatório) — Identificador do motorista.

Response body:

[
{
"id": 0,
"licensePlate": "string",
"modelMotor": "string",
"modelVersion": "string",
"modelInitialYear": "string",
"modelEndYear": "string",
"modelDescription": "string",
"modelBrand": "string",
"modelYear": "string"
}
]

Pesquisar motoristas

Pesquisa motoristas utilizando os filtros informados.

Endpoint: /api/drivers/filters

Método: GET

Parâmetros:

  • driverFilterDTO (query, obrigatório) — Filtros utilizados na pesquisa.
  • page (query, obrigatório) — Informações de paginação.

Response body:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"id": 0,
"name": "string",
"email": "string",
"clientName": "string",
"active": true,
"role": "DRIVER"
}
],
"number": 0,
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}

Autocomplete de motoristas

Retorna sugestões de motoristas com base no nome informado.

Endpoint: /api/drivers/autocomplete

Método: GET

Parâmetros:

  • driverFilterDTO (query, obrigatório) — Filtros utilizados para localizar o motorista.

Response body:

[
{
"display": "string",
"value": 0
}
]