Consultar cidades

Consulte informações sobre cidades registradas no Sankhya ERP através da API de serviços

Parâmetros

Parâmetros de configuração.

Campo	Tipo	Descrição
Conta de serviço	Select	Permite o acesso ao sistema através de credenciais fornecidas no painel de contas do Floui.
Filtro por campo	String	Utilize campos internos para aplicar filtros de buscas.
Valor	String	Define um valor associado ao filtro por campo.
Tipo do valor	Select	Define o tipo primitivo do valor aplicado.
Campos para retorno na consulta	String	Crie a sua estrutura de retorno esperada usando os campos internos.
Número de resultados por página	String	Define um número de itens encontrados por página.
Página atual	String	Define a página de visualização padrão.
Retorno em modo simplificado	Select	Retorna os dados de resultado da consulta em modo simplificado ao invés da resposta padrão da Sankhya.
Output path	String	Armazena os dados de saída do conector ao final da execução.
Descrição	String	Mensagem visual para descrever a função do conector no contexto do fluxo.

Consulta de Cidades

get

    "criteria": {
                "expression": {
                  "$": "this.CODCID = 490"
                }
              }

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "Cidade",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODCID = 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"
              }
          }
      }
  }
}

Responses

201

Consulta efetuada com sucesso

400

Requisição inválida

500

Erro interno do servidor

get

/Cidade

HTTPcURLJavaScriptPython

GET /Cidade HTTP/1.1
Accept: */*

No content