Cross Segmentos - TOTVS Backoffice Linha Protheus - ADVPL - É possível retornar o detalhe da mensagem de erro utilizando a função SetRestFault em APIs TLPP?

Tempo aproximado para leitura: 00:05:00 min

Dúvida
É possível retornar o detalhe da mensagem de erro utilizando a função SetRestFault em APIs TLPP?

Ambiente
Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - Todas as versões 

Solução
Em TLPP, não temos o TTALK como no AdvPL, dessa forma, não é possível utilizar o parâmetro cDetailMsg para retornar os detalhes da mensagem de erro utilizando a função SetRestFault. Logo, em APIs TLPP, pode ser utilizado o SetFault para atender a necessidade.
*Importante possuir a configuração do REST TLPP para o funcionamento. 

**O TTALK mencionado acima é responsável por padronizar as mensagens trocadas entre os diversos produtos de diferentes marcas da Totvs. No TLPP, o TTALK não existe, ficando a critério do desenvolvedor responsável padronizar as mensagens. Para maiores detalhes, veja na seção Saiba mais.

Exemplos:

#include "tlpp-core.th"
#include "tlpp-rest.th"

@Get("/documentation/setFault")
Function u_fSetFault()
    Local cResponse := ""
    Local lRet      := ""

    cResponse := '{"setFault": "método setFault executado com sucesso, mensagem de retorno padrao alterada"}'
    lRet := oRest:setFault(cResponse)
return .T.

Saiba mais
SetRestFault
SetFault
REST Tlpp
TTALK