Critérios pré-definidos
A Mobile Saúde adota estes critérios de preenchimento para todas as suas documentações técnicas.
Abreviação | Nome | Descrição |
|---|---|---|
C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
Objetos e atributos de retorno
A Mobile Saúde utiliza de consumir os atributos de retorno no estilo camelCase.
O que é?
O camelCase é a denominação em inglês para a prática de escrever as palavras compostas ou frases, onde cada palavra é iniciada com maiúsculas e unidas sem espaços.
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.
Exemplo do atributo "usuarioLogado":
usuario-logado
usuario_logado
usuario
usuarioLogado
Descrição dos objetos e atributos de retorno - falha
Conceitualmente, quando algo de errado acontece, você deve devolver FALHA (ou seja, um código de ERRO que indique a natureza da falha - 403 ou 500 por exemplo).
PORÉM, quando sua API retorna um conteúdo VAZIO (ou seja, não existem registros a serem exibidos) você PRECISARÁ DEVOLVER UM RETORNO 200 e o conteúdo vazio.
Está indicado abaixo a estrutura de retorno do seu método implementado. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Caso o retorno de uma API seja VAZIO, lembre-se de devolver o status 200. Utilize o retorno de falha SOMENTE SE houver uma falha que precise ser tratada.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo de retorno com "Falha”
{
"mensagem": "Informe uma mensagem de erro de acordo com o contexto da requisição"
}
LEMBRETE: Caso o retorno da API esteja VAZIO, devolva status 200 e objeto vazio na API.
Mobile Saúde - Mosia Omnichannel