Versões comparadas
comparado com
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Tópicos:
Índice
URL Base
| Ambientes | URL |
|---|---|
| Homologação | https://ms3.tapcore.com.br/mssuite/ |
| Produção | https://ms3.tapcore.com.br/mssuite/ |
Endpoint
| Endpoint | Método | Descrição |
|---|---|---|
/atualizacaocancelamento_cadastralplano/api/v1/ws/formulario/atualiza_status_protocolo | POST | Atualiza o status de um protocolo de atualização cadastral iniciadocancelamento de plano solicitado. |
Parâmetros
| Parâmetro | Obrigatório | Tipo | Descrição | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| id_operadora | true |
| Id da operadora para a qual serão buscados os grupos de menu | |||||||
mshash | true |
| HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. | |||||||
matricula | true |
| Matrícula do beneficiário | |||||||
protocolo | true |
| Protocolo da Solicitação Cadastral. | |||||||
| status | true |
| Status requerido. | |||||||
observacao | false |
| Algumas observações feitas pelo usuário. |
Retorno API (Sucesso)
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"status": true,
"data": [],
"critica": [],
"timestamp": "2017-08-02T10:52:13-03:00",
"msg":"Sucesso"
} |
| Informações |
|---|
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)
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"status": false,
"data": [],
"critica": [
{
"cod": 0,
"descricao": "O status é inválido",
"origem": "/mssuite/atualizacaocancelamento_cadastralplano/api/v1/ws/formulario/atualiza_status_protocolo/",
"trace": ""
}
],
"timestamp": "2019-04-22T11:12:51-03:00",
"msg": "O status é inválido"
} |