TAS_getFieldLength

Função que retorna a quantidade de ocorrências de uma determinada informação de um serviço disponível no TOTVS Api Services (TAS). É 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 quantidade total de 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.

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.

Sintaxe

TAS_getFieldLength ( < l_fieldList > )  => INTEGER

Parâmetros

Nome

Tipo

Obrigatório?

Descrição

l_fieldList

CHAR

Sim

Nome do campo que deseja identificar a quantidade de ocorrências no respectivo serviço que foi feita carga prévia de informações pelas funções TAS_<serviço>_load().

Somente informe campos do serviço que estiverem definidos como tipo LISTA no serviço do TAS. Em caso de dúvidas consulte o retorno da API do serviço desejado em Documentação APIs TAS (Swagger)

Este nome de campo deve ser descrito no padrão XPATH. Exemplo: suframa/inscricoesEstaduais

Retorno

Tipo	Descrição
`INTEGER`	Quantidade de ocorrências do campo do serviço do TAS que foi pré-carregado por uma das funções TAS_<serviço>_load().

Exemplo

#--------------------------------------#
 FUNCTION TAS_getFieldLength_test()
#--------------------------------------#
    DEFINE l_idx, l_count  SMALLINT
 
    IF TAS_SUFRAMA_load('20337684000129',NULL) THEN

        ## Após fazer a busca de informações SUFRAMa para um determinado CNPJ usando a função TAS_SUFRAMA_load(), 
        ## é feita a recuperação da quantidade de inscrições estaduais registradas para este CNPJ no serviço SUFRAMA
        ## o campo inscricoesEstaduais na resposta do serviço SUFRAMA retorna uma lista como resultando e por isso é 
        ## possivel utilizar a função TAS_getFieldLength() para recuperar a quantidade de informações contidas na lista deste camppo
        LET l_count = TAS_getFieldLength("suframa/inscricoesEstaduais") 

        FOR l_idx = 1 TO l_count
            CALL CONOUT("TAS_SUFRAMA_getInscricaoEstadual["||LOG_alltrim(l_idx)||"]", TAS_SUFRAMA_getInscricaoEstadual(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)

Páginas filhas