Comparação de Páginas

Índice

minLevel	1
maxLevel	7

...

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

Nota

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 "contatos":

Dica
Atente-se as orientações fornecidas pela Mobile Saúde; Atente-se as orientações de segurança e permissões; Atente-se aos critérios de preenchimento; Atente-se aos critérios de objetos e atributos de retorno; Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Método

Header Content-Type

Descrição

/primeiroAcesso

Nota

Atenção

O endpoint obrigatoriamente deve terminar com "/primeiroAcesso".

POST

application/json

Endpoint de primeiro acesso

Informações
Formulário dinâmico criado pelo Formbuilder. A aplicação fica responsável por encaminhar o formulário informado para o método de primeiro acesso. Os parâmetros de entrada devem ser devidamente informados no formulário de autenticação utilizado configurador de integração.

...

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Bloco de código

language	json

{
   "status": true,
   "mensagem": "Beneficiário não encontrado",
}