Consulta de Rotas

Regras de negócio

Para realizar a consulta de rotas no sistema ERP é necessário preencher os dados obrigatórios.Para que seja possível,consultar a rota e o valor que será gasto em cada trajeto do veículo.
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/360045108613-Rotas

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Rota que por sua vez instancia a tabela TGFROT 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 CODROTA, porém você pode utilizar outros campos da entidade .

• CODROTA – Código da Rota.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
    "criteria": {
      "expression": {
        "$": "this.CODROTA = ?"
      },
      "parameter":[
        {
           "type":"I",
           "value":"216"
        }
      ]
    }

Caso deseje pesquisar por todos as rotas cadastrados, basta remover o trecho acima do json para retornar todas as rotas cadastradas previamente.

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 TGFROT

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": "Rota",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODROTA = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":"216"
          }
        ]
      },
      "entity": {
        "fieldset": {
              "list":"CODROTA,DESCRROTA,DISTANCIA"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "DAF689FF87DEDAAF5942CBE75D934484",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODROTA"
                        },
                        {
                            "name": "DESCRROTA"
                        },
                        {
                            "name": "DISTANCIA"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "216"
                },
                "f1": {
                    "$": "UBERABA"
                },
                "f2": {
                    "$": "90"
                }
            }
        }
    }
}
Language
Click Try It! to start a request and see the response here!