Regras de negócio

Para realizar o consulta de cidades no sistema ERP é necessário efetuar o cadastro das cidades. Este preenchimento pode ser realizado automaticamente, ou de forma manual.
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/360045110913-Cidades

Dependências

Não possui dependências

Detalhes Técnicos

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

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 TSICID

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": "Cidade",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODCID = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":"490"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODCID,NOMECID,UF"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "A5AEA95E7F721374E2AC69B3486E444E",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODCID"
                      },
                      {
                          "name": "NOMECID"
                      },
                      {
                          "name": "UF"
                      },
                      {
                          "name": "UnidadeFederativa_UF"
                      }
                  ]
              }
          },
          "entity": {
              "f0": {
                  "$": "490"
              },
              "f1": {
                  "$": "UBERLANDIA"
              },
              "f2": {
                  "$": "2"
              },
              "f3": {
                  "$": "MG"
              }
          }
      }
  }
}