DriveB

30. Região

Este módulo permite consultar as regiões utilizadas para precificação e categorização de serviços e peças.

Funcionalidades Principais

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

Obter uma região por ID

Retorna os dados de uma região específica.

Endpoint: /api/regions/{id}

Método: GET

Parâmetros:

  • id (path, obrigatório) — Identificador da região.

Response body:

{
"id": 0,
"tag": "string",
"description": "string",
"type": "string",
"isDefault": true,
"countryId": 0,
"countryName": "string"
}

Listar tipos de regiões

Retorna todos os tipos de regiões disponíveis no sistema.

Endpoint: /api/regions/types

Método: GET

Parâmetros:

  • Este endpoint não recebe parâmetros.

Response body:

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

Listar regiões de serviços

Retorna todas as regiões utilizadas para serviços.

Endpoint: /api/regions/services

Método: GET

Parâmetros:

  • Este endpoint não recebe parâmetros.

Response body:

[
{
"id": 0,
"tag": "string",
"description": "string",
"type": "string",
"isDefault": true,
"countryId": 0,
"countryName": "string"
}
]

Listar regiões de peças

Retorna todas as regiões utilizadas para peças.

Endpoint: /api/regions/parts

Método: GET

Parâmetros:

  • Este endpoint não recebe parâmetros.

Response body:

[
{
"id": 0,
"tag": "string",
"description": "string",
"type": "string",
"isDefault": true,
"countryId": 0,
"countryName": "string"
}
]

Pesquisar regiões

Pesquise regiões utilizando os filtros informados.

Endpoint: /api/regions/filters

Método: GET

Parâmetros:

  • regionFilterDTO (query, obrigatório) — Filtros utilizados na pesquisa das regiões.

Response body:

[
{
"id": 0,
"tag": "string",
"description": "string",
"type": "string",
"isDefault": true,
"countryId": 0,
"countryName": "string"
}
]