Consulta de Endereços

Regras de negócio

Nesta rotina é realizado a consulta de endereços que serão utilizados nos diversos procedimentos do sistema. Para aprimorar, todos os cadastros e permitir a seleção uniforme, se faz necessário cadastrá-los de forma padronizada.
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/360044602274-Endere%C3%A7os

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Endereco que por sua vez instancia a tabela TSIEND 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 CODEND, 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.CODEND = ?"
      },
      "parameter":[
        {
           "type":"I",
           "value":450
        }
      ]
    }

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 TSIEND

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": "Endereco",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODEND = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":450
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODEND,NOMEEND,TIPO,CODLOGRADOURO"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "87BD1010D80509835CCA244A1F54CA94",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODEND"
                      },
                      {
                          "name": "NOMEEND"
                      },
                      {
                          "name": "TIPO"
                      },
                      {
                          "name": "CODLOGRADOURO"
                      }
                  ]
              }
          },
          "entity": {
              "f0": {
                  "$": "450"
              },
              "f1": {
                  "$": "OSVALDO CRUZ"
              },
              "f2": {
                  "$": "AVENIDA"
              },
              "f3": {}
          }
      }
  }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!