Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Método submit_formulario
  1. Regras de Negocio do Método
  2. EndPoint
  3. Parâmetros de Entrada do Método
  4. Exemplo
  5. Estrutura de Retorno
Tela Atualização CadastralTela XXX
1. Outras Ações / Ações relacionadas
Tela XXXAtualização Cadastral
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/submit_formulario	POST	application/json	Inserir um nova solicitação de atualização cadastral do beneficiário para análise

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
protocolo	Sim	Caracter	Protocolo da Atualização Cadastral, será gravado no campo BBA_NROPRO da Analise de Beneficiários
id_operadora	Sim	Numerico	ID da Operadora na Mobile Saúde
mshash	Sim	Caracter	HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados na Mobile Saúde.
tipo	Não	Caracter	Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado).
nome	Sim	Caracter	Nome do Beneficiário
matricula	Sim	Caracter	Matricula do Beneficiários (Operadora + Empresa + Matricula + Tipo Registro + Digito)
matricula_titular	Sim	Caracter	Matricula do Títular do Plano (Operadora + Empresa + Matricula + Tipo Registro + Digito)
campos	Sim	Array	Lista de Objetos
id	Sim	Caracter	ID do campo na Mobile Saúde
label	Sim	Caracter	Label da opção preenchida ou selecionada pelo usuário na Mobile Saúde
name	Sim	Caracter	Nome do Campo na Mobile Saúde
value	Sim	Caracter	Valor do Campo

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
   "protocolo":"41750520220318145554",
   "id_operadora":1,
   "mshash":"ZDhkNjY0MDY3NTgwMTg0Y2I4ZWE3ZmZiZGEyNDM0NmMwZDI0YmQwYw==",
   "tipo":"",
   "nome":"SEBASTIAO CARLOS FELIPE MELO",
   "matricula":"00011008000007035",
   "matricula_titular":"00011008000007035",
   "campos":[
      {
         "id":"10",
         "label":"bairro",
         "name":"atualizacao_cadastral_bairro",
         "value":"Centro"
      },
      {
         "id":"11",
         "label":"endereco",
         "name":"atualizacao_cadastral_endereco",
         "value":"Rua Teste"
      },
      {
         "id":"11",
         "label":"endereco",
         "name":"atualizacao_cadastral_comprovante_de_endereco",
         "value":"https://centraldeatendimento.totvs.com/hc/article_attachments/360027449931/mceclip2.png"
      }
   ]
}

...

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

{
    "timestamp": "2022-03-21T17:23:15-03:00",
    "data": [],
    "status": false,
    "critica": [
        {
            "cod": 0,
            "trace": "",
            "origem": "/mobileSaude/submit_formulario",
            "descricao": " Protocolo informado já existente no sistema. [41750520220318145551]"
        }
    ],
    "msg": "Protocolo informado já existente no sistema. [41750520220318145551]"
}

Estrutura de Retorno

Atributo	Tipo	Descrição

03. TELA XXXXX

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

03. TELA XXXXX