Frameworkjoi

Home

Frameworkjoi

Child pages
  • LRESTLOGIXRESPONSE:Get:GENERATE

Efetua a geração do retorno da requisição REST, com base nas informações de PAYLOAD, MESSAGE e STATUS já previamente setados.

Sintaxe

_ADVPL_get_property(< l_reference >, "GENERATE" ) => CHAR

Retorno

TipoDescrição
CHAR

Conteúdo texto gerado no formato JSON, que será utilizado como retorno do resultado da requisição REST, já convertido no formato UTF8.

Exemplo

Exemplo GET GENERATE
#------------------------------------------------------------------------------#
FUNCTION LRESTLOGIXRESPONSE_getGENERATE()
#------------------------------------------------------------------------------#
    DEFINE l_json_reference VARCHAR(10)
    DEFINE l_logix_response VARCHAR(10)
    DEFINE l_json CHAR(1000)
     
    #--# Utilização do método SERIALIZE da classe LJSONOBJECT  #--#
    LET l_json = _ADVPL_get_property(l_json_reference,"SERIALIZE")
     
    #--# Criação da resposta padronizada utilizando a classe LRestLogixResponse  #--#
    LET l_logix_response = _ADVPL_create_component(NULL,"LRestLogixResponse")
    CALL _ADVPL_set_property(l_logix_response,"PAYLOAD",l_json)
 
    #--# Propriedades opcionais #--#
    CALL _ADVPL_set_property(l_logix_response,"MESSAGE","Erro Msg","Erro Detail", "10")
    CALL _ADVPL_set_property(l_logix_response,"STATUS",'200')
 
    #--# Opcional, utilizada quando o conteúdo de retorno for um JSONArray #--#
    CALL _ADVPL_set_property(l_logix_response,"HAS_NEXT",TRUE)
     
    RETURN _ADVPL_get_property(l_logix_response,"GENERATE")
END FUNCTION

Veja também

Exemplos completos disponíveis no Guia de Desenvolvimento de APIs para o produto Logix.