Linha Logix

Páginas filhas
  • TAS_getFieldListValue

Versões comparadas

Versão antiga 1

changes.mady.by.user Ieda Ferreira Alves Flock

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Cleane Hermann

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Função para

Retorna o valor de um item de um campo de um serviço disponível via TOTVS Api Services (TAS) que é retornado no formato de lista. É também possível retornar a lista completa de

todas todos os itens de uma lista (separado por vírgula).

itens da lista do campo, sendo que os valores da lista são separados por vírgula.

Esta função é usada para campos que tem registrado no serviço desejado do TAS, não apenas uma informação única, mas uma lista de informações que pode variar de 0 (zero) a várias ocorrências.

Exemplo: No serviço SUFRAMA, podem existir uma ou mais inscrições estaduais que está disponivel no campo suframa/inscricoesEstaduais e para recuperar a uma ou todas as inscrições estaduais disponíveis para um determinado CNPJ e Unidade de Federação (Estado), utiliza-se esta função para o campo suframa/inscricoesEstaduais.

(seleção) Esta função tem como pré-requisito realizar a consulta de dados em um dos serviços disponíveis para integração com o TAS no produto LOGIX como por exemplo, TAS_CNPJ_load,  TAS_CPF_load,  TAS_SUFRAMA_load. (seleção)


Sintaxe

Painel
TAS_
getFieldLength ( [ 
getFieldListValue ( < l_fieldList
], [ 
 >, < l_idx
]
 >, [ l_field ]
) → BOOLEAN
 )   => CHAR


Parâmetros

NomeTipoObrigatório?Descrição
l_fieldList
CHAR
Simlista com os campoNome do campo, no formato XPATH, que é retornado no formato de lista no serviço do TAS, para o qual deseja recuperar um ou mais valores.
l_idx 
SMALLINT
Sim

Informe a ordem do item da lista de itens que deseja recuperar valor.

Caso informe o valor 0 (zero), será retornada a lista completa Quantidade de itens da lista do campo informado, sendo que os itens da lista serão separados por vírgula.   Exemplo: "item1,item2,item3"

l_field 
CHAR
Sim

Nome do elemento dentro da lista resultante do campo do serviço desejado.

Exemplo: No serviço SUFRAMA, temos o campo inscricoesEstaduais que é uma Lista de inscrições estaduais que possui alguns elementos conforme abaixo:

  • {suframa}: Resultado da consulta na Suframa.
    • {inscricoesEstaduais}: Lista de inscrições estaduais
      • {inscricaoEstadual}
      • {razaoSocial}
      • {nomeFantasia}
      • {logradouro}
      • {complemento}
      • {bairro}
      • {cep}
      • {municipio}
      • {uf}
      • {telefone}
      • {atividadeEconomica}
      • {atividadesEconomicasSecundarias}: Lista de atividades econômicas
      • {atividadeEconomicaEstadual}
      • {tipoIncentivo}
      • {situacaoCadastral}
      • {dataSituacao}
      • {observacao}
      • {urlComprovante}: Comprovante de consulta da fonte de dados


Para recuperar o Número de uma das inscrições estaduais da lista do campo inscricoesEstaduais, deve-se informar o nome do elemento inscricaoEstadual. 

Retorno

TipoDescrição

QUALQUERCHAR

Valor

da propriedade informada do componente

de um item da lista de um dos campos do serviço disponível no TAS.

Quando retornar a lista completa, os valores estarão separados por vírgula.

Exemplo

Bloco de código
languageruby
linenumberstrue
#--------------------------------------------------------#
 FUNCTION TAS_CNPJ_getAtividadeEconomicaSecundaria_test(l_idx)
#--------------------------------------------------------#
#Valores:   0 DEFINE l_idx retorna lista completaSMALLINT
 separada por vírgula
# DEFINE l_count SMALLINT

     >0  retorna a atividade na ordem específica da lista retornada
    DEFINE l_idx   SMALLINT
    
    RETURN IF TAS_CNPJ_load("<número de CNPJ>") THEN
	    LET l_count = TAS_getFieldLength("receitaFederal/atividadesEconomicasSecundarias")

		FOR l_idx = 1 TO l_count
            #Neste caso o campo atividadesEconomicasSecundarias não possui nome para os elementos da lista, por isso o 3o parâmetro ficou em branco
		    CALL conout("Atividade Economica Secundaria "||l_idx||": "||TAS_getFieldListValue("receitaFederal/atividadesEconomicasSecundarias",l_idx,""))
		END FOR
     END IF
 END FUNCTION


Informações

Fontes: tas.4gl

Disponível a partir do pacote Logix 12.1.2305 ou Fix Framework Logix 12.1.2305.fix01.

Veja também 

Integração Logix x TAS

Documentação APIs TAS (Swagger)