Regras de negócio

Para realizar a consulta Bairro no sistema, primeiramente será necessário efetuar o cadastro do bairro para melhor organização e visualização dos mesmos; a seleção dos registros se dá independentemente de conter letras maiúsculas ou minúsculas.
No sistema a consulta de bairros é independente da consulta de (cidades) sendo necessário criar endereços ou bairros com o mesmo nome para cidades distintas; basta cadastrar uma única vez e o mesmo servirá para todas as cidades.Logo, o sistema não permite o cadastro repetido do mesmo bairro.
OBS: Caso tenha alguma necessidade de configuração do ERP procure “consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044599814-Bairro

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Bairro que por sua vez instancia a tabela TSIBAI mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é um otimo serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro o campo CODBAI, porém você pode utilizar outros campos da entidade .

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:

    "criteria": {
      "expression": {
        "$": "this.CODBAI = ?"
      },
      "parameter":[
        {
           "type":"I",
           "value":"417"
        }
      ]
    }

Para melhor performance sempre utilize nas suas consultas apenas os campos necessários, para evitar tráfego de dados que não serão utilizados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TSIBAI

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "Bairro",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODBAI = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":"417"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODBAI,NOMEBAI"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "7BB9E12043A4F153CD8EF0DBC6219F94",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODBAI"
                        },
                        {
                            "name": "NOMEBAI"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "417"
                },
                "f1": {
                    "$": "BOA VISTA"
                }
            }
        }
    }
}