Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

Versão 1

Tópicos:

URL Base


Endpoint

EndpointMétodoDescrição

/atualizacao_cadastral/api/v1/ws/formulario/atualiza_status_protocolo

POST

Atualiza o status de um protocolo de atualização cadastral iniciado.


Parâmetros

ParâmetroObrigatórioTipoDescrição
id_operadoratrue
Inteiro

Id da operadora para a qual serão buscados os grupos de menu

mshash

true

String

HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

matriculatrue
String
Matrícula do beneficiário
protocolotrue
String
Protocolo da Solicitação Cadastral.
statustrue
Inteiro
Status requerido.
observacaofalse
String
Algumas observações feitas pelo usuário.


Retorno API (Sucesso)

Retorno API sucesso
{
    "status": true,
    "data": [],
    "critica": [],
    "timestamp": "2017-08-02T10:52:13-03:00",
    "msg":"Sucesso"
}

Os valores e o array do campo "alterados", que fica organizado em grupos, é dinamicamente alterado conforme a configuração do seu formulário.

Exemplo de retorno API (Erro)

Retorno API falha
{
    "status": false,
    "data": [],
    "critica": [
        {
            "cod": 0,
            "descricao": "O status é inválido",
            "origem": "/mssuite/atualizacao_cadastral/api/v1/ws/formulario/atualiza_status_protocolo/",
            "trace": ""
        }
    ],
    "timestamp": "2019-04-22T11:12:51-03:00",
    "msg": "O status é inválido"
}


  • Sem rótulos