Consulta de Regiões

Regras de negócio

O cadastro de regiões no sistema ERP possibilita o fracionamento de determinado espaço geográfico em regiões, facilitando, por exemplo, a cobrança de frete de acordo com a região e a definição de áreas de atuação de vendedores.
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/360044599074-Regi%C3%B5es

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Regiao que por sua vez instancia a tabela TSIREG 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.

Na busca dos dados foi utilizado apenas o campo CODREG, porém também podem ser utilizados os demais campos para consulta utilizando filtro no corpo da requisição.
Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
    "criteria": {
      "expression": {
        "$": "this.CODREG = ?"
      },
      "parameters":[
        {
           "type":"I",
           "value":"10999"
        }
      ]
    }

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 TSIREG

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": "Regiao",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODREG = ?"
        },
        "parameters":[
          {
             "type":"I",
             "value":"10999"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODREG,NOMEREG,CODREGPAI"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "C4C7F19C971319FC582D366ECBE95AD2",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODREG"
                        },
                        {
                            "name": "NOMEREG"
                        },
                        {
                            "name": "CODREGPAI"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "10999"
                },
                "f1": {
                    "$": "3 B's do TRIÂNGULO"
                },
                "f2": {
                    "$": "10000"
                }
            }
        }
    }
}
Language
Click Try It! to start a request and see the response here!