Histórico da Página

...

...

Expandir

title	Definição dos campos de requisição

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

...

Expandir

title	Definição dos campos de retorno

Expandir

title	200 - Ok

Expandir

title	400 - Bad Request

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

Deck of Cards

id	clienteBadRequest

Card

label	Caso 1

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

Card

label	Caso 2

Informações
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

Expandir

title	Body de retorno

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

Árvore de páginas