PUT ClienteMensagens

Este método é responsável pela atualização de status do cliente mensagem

Endpoint:
- V2: /api/retaguarda/v2/ClienteMensagens/{IdInquilino}
- V3: /api/retaguarda/v3/ClienteMensagens/{IdInquilino}
Método: Put
Autenticação: Bearer token
Permissão: Retaguarda

Pode-se passar uma lista de de status

Exemplo de body da requisição

[
{
"idMensagem": 1117,
"status": 1
}
]

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
idMensagem	String	Identificador do cliente no banco de dados do POSH	Obrigatório
status	Int	Status do cliente (Descritivo abaixo)	Opcional

Status

Código	Status
0	Pendente consumo da retaguarda
1	Consumido pela retaguarda
2	Consumido com erro pela retaguarda
4	Integrado com sucesso pela retaguarda
5	Venda reenviada. Integrado com sucesso pela retaguarda

Definição dos campos de retorno

200 - Ok

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data	objeto	Objeto Alterado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

400 - Bad Request

Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação

Campo	Tipo	Descrição
Success	bool	Indica se a criação do cliente foi feita com sucesso
Message	string	Messagem com os erros
Data	objeto	Objeto cliente
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Body de retorno

{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Árvore de páginas