Objeto de resposta padrão

Descrição

O objetivo do objeto padrão de retorno é garantir consistência na estrutura das respostas de todos os endpoints da API. Esse padrão define campos como status, data, message e errors, proporcionando mais clareza nas informações e facilitando a integração e o consumo dos serviços por aplicações externas.

Estrutura do Objeto

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

Descrição dos parâmetros

Parâmetro	Tipo	Descrição
Status	String	Indica o status da operação. Valores possíveis: `wrsSuccess`: Operação realizada com sucesso ou `wrsError`: Ocorreu um erro na operação
ErrorCode	String	Código do erro retornado quando a operação não é bem-sucedida. Se o campo estiver vazio, significa que não ocorreu nenhum erro
Message	String	Mensagem detalhada do erro apresentado
Actor	String	Identificação do usuário ou sistema que realizou a operação
ReturnQuestion	Object/Null	Informação adicional retornada pelo sistema, podendo variar de acordo com o contexto

❗Aviso Importante sobre HTTP Response

⚠️ Nossa API sempre retorna o status HTTP 200, mesmo em casos de erro de negócio.
Os erros devem ser tratados no objeto de resposta, com base no conteúdo retornado.

Somente erros internos do servidor serão retornados como 500 - Internal Server Error.

Deve-se verificar o campo status no corpo da resposta para identificar possíveis falhas ou erros de negócio.

Exemplo de Retorno Bem-Sucedido

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

Exemplo de Retorno com Erro

{
    "WebServiceReturn": {
        "Status": "wrsError",
        "ErrorCode": "WSR-004",
        "Message": "Provided \"GetCustomInfoParams.CustomInfoScriptName\" information is invalid!",
        "Actor": "GetCustomInfo/GetCustomInfoCore/ValidateAndLoadQueryCustomParams",
        "ReturnQuestion": null
    }
}

Considerações

Status: É obrigatório para identificar o resultado da operação.
ErrorCode e Message: Devem ser utilizados para depuração e exibição de mensagens ao usuário.
Actor: Pode ser utilizado para auditoria ou identificação de em que estado a API encontrou o problema.
ReturnQuestion: É opcional e pode conter informações adicionais específicas para o endpoint.

Descrição​

Estrutura do Objeto​

Descrição dos parâmetros​

❗Aviso Importante sobre HTTP Response​

Exemplo de Retorno Bem-Sucedido​

Exemplo de Retorno com Erro​

Considerações​