DriveB

11. Blocos

Este módulo permite consultar e localizar blocos cadastrados na plataforma, retornando informações detalhadas ou simplificadas de acordo com o endpoint utilizado.

Funcionalidades Principais

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

Consultar bloco por ID

Recupere as informações completas de um bloco através do seu identificador.

Endpoint: /api/blocks/{id}

Método: GET

Request payload:

true

Response body:

{
"id": 0,
"blockCode": "string",
"tag": "string",
"parentId": 0,
"parent": {
"id": 0,
"clientCode": "string",
"sapId": "string",
"corporateName": "string",
"tradingName": "string",
"taxIdentifier": "string",
"isParent": true,
"clientType": "DEFAULT",
"negotiationId": 0
},
"address": {
"id": 0,
"street": "string",
"zipCode": "string",
"number": "string",
"district": "string",
"complement": "string",
"cityId": 0,
"city": {
"id": 0,
"name": "string",
"state": null
},
"cityName": "string",
"stateName": "string",
"countryName": "string",
"ibgeCode": "string"
}
}

Listar todos os blocos

Retorne uma lista simplificada contendo os principais dados de todos os blocos cadastrados.

Endpoint: /api/v2/blocks/allSimplified

Método: GET

Request payload:

true

Response body:

[
{
"id": 0,
"blockCode": "string",
"tag": "string"
}
]

Pesquisar blocos por filtros

Permite pesquisar blocos utilizando filtros informativos.

Endpoint: /api/blocks/filters

Método: GET

Request payload:

true

Response body:

[
{
"id": 0,
"blockCode": "string",
"tag": "string",
"parentId": 0,
"parent": {
"id": 0,
"clientCode": "string",
"sapId": "string",
"corporateName": "string",
"tradingName": "string",
"taxIdentifier": "string",
"isParent": true,
"clientType": "DEFAULT",
"negotiationId": 0
},
"address": {
"id": 0,
"street": "string",
"zipCode": "string",
"number": "string",
"district": "string",
"complement": "string",
"cityId": 0,
"city": {
"id": null,
"name": null,
"state": null
},
"cityName": "string",
"stateName": "string",
"countryName": "string",
"ibgeCode": "string"
}
}
]

Buscar bloco pelo código do bloco

Localize blocos através do código do bloco, retornando opções para autocomplete.

Endpoint: /api/blocks/autocomplete

Método: GET

Request payload:

true

Response body:

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