Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Tópicos:

Índice

URL Base


Endpoint

EndpointMétodoDescrição

/cancelamento_plano/api/v1/ws/formulario/get_protocolo

GET

Retorna o status do protocolo requerido.



Parâmetros

ParâmetroObrigatórioTipoDescrição
id_operadoratrue


Cor do plano de fundo
color#EDEEF1
Inteiro


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

mshash

true


Cor do plano de fundo
color#EDEEF1
idtipo
String


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

id_protocolotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro


ID do protocolo requerido.


Retorno API (Sucesso)

Bloco de código
languagejs
themeMidnight
titleRetorno API sucesso
linenumberstrue
{
    "status": true,
    "data": [
        {
            "id_protocolo": 17399,
            "id_operadora": 120,
            "id_aplicacao": 7,
            "protocolo": "32557120190418800001",
            "id_ms_usuario": "",
       
    "data": "2019-04-18 14:07:21",
            "status": 0,
            "matricula": "00410001000098717",
            "matricula_titular": "00410001000098717",
            "tipo": "t",
            "nome": "NEWTON BENTO ALVES",
            "observacao": "",
            "classe": null,
            "tipo_guia": "Exame",
            "login": 410001000098717,
            "valores": [
                {
                    "id_grupo": 9,
                    "nome": "Beneficiário",
                    "alterados": [
                        {
                            "id_campo": 94,
                            "id_protocolo_dados": 154765,
                            "id_protocolo": 17399,
                            "valor": "NEWTON BENTO ALVES",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Nome",
                            "nome": "solic_autorizacoes_nome",
                            "tipo": "grupo_familia",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 9,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 94,
                            "id_protocolo_dados": 154765,
                            "id_protocolo": 17399,
                            "valor": "00410001000098717",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Matrícula",
                            "nome": "solic_autorizacoes_nome",
                            "tipo": "grupo_familia",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 9,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 226,
                            "id_protocolo_dados": 154764,
                            "id_protocolo": 17399,
                            "valor": "07/04/2019",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Data da Realização",
                            "nome": "solic_autorizacoes_data",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": "data",
                            "id_grupo_campo": 9,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 227,
                            "id_protocolo_dados": 154771,
                            "id_protocolo": 17399,
                            "valor": "Vitoria",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Local da Realização",
                            "nome": "solic_autorizacoes_local",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 9,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 236,
                            "id_protocolo_dados": 154769,
                            "id_protocolo": 17399,
                            "valor": "Teste",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Observacao",
                            "nome": "solic_autorizacoes_observacao",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 9,
                            "tipo_guia": "Exame"
                        }
                    ]
                },
                {
                    "id_grupo": 10,
                    "nome": "Dados de Contato",
                    "alterados": [
                        {
                            "id_campo": 95,
                            "id_protocolo_dados": 154768,
                            "id_protocolo": 17399,
                            "valor": "NEWTON BENTO ALVES",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Nome do contato",
                            "nome": "solic_autorizacoes_nome_contato",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 96,
                            "id_protocolo_dados": 154770,
                            "id_protocolo": 17399,
                            "valor": "(54) 9911-4652",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Telefone do contato",
                            "nome": "solic_autorizacoes_telefone",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": "telefone",
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 97,
                            "id_protocolo_dados": 154766,
                            "id_protocolo": 17399,
                            "valor": "(54) 98442-2017",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Whatsapp",
                            "nome": "solic_autorizacoes_whatsapp",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": "celular",
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 98,
                            "id_protocolo_dados": 154767,
                            "id_protocolo": 17399,
                            "valor": "teste@gmail.com",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "E-mail",
                            "nome": "solic_autorizacoes_email",
                            "tipo": "text",
                            "tamanho": "12",
                            "classe": "email",
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 99,
                            "id_protocolo_dados": 154772,
                            "id_protocolo": 17399,
                            "valor": "https://cancelamento-plano.s3-sa-east-1.amazonaws.com/2E53B1D4-1912-4AD5-B871-EE10433659A3-803-0000011647DEA61F.jpeg",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Imagem da guia",
                            "nome": "solic_autorizacoes_imagens",
                            "tipo": "file",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        },
                        {
                            "id_campo": 241,
                            "id_protocolo_dados": 154773,
                            "id_protocolo": 17399,
                            "valor": "https://cancelamento-plano.s3-sa-east-1.amazonaws.com/D38DED40-7056-4798-BBAD-96CC0CDE1869-803-000001165885DD11.jpeg",
                            "data_solicitacao": "2019-04-18 14:07:21",
                            "label": "Imagem da carteirinha",
                            "nome": "solic_autorizacoes_imagens",
                            "tipo": "file",
                            "tamanho": "12",
                            "classe": null,
                            "id_grupo_campo": 10,
                            "tipo_guia": "Exame"
                        }
                    ]
                }
            ]
        }
    ],
    "critica": [],
    "timestamp": "2019-04-22T11:22:19-03:00",
    "msg": null
}

Exemplo de retorno API (Erro)

Bloco de código
languagejs
themeMidnight
titleRetorno API falha
linenumberstrue
{
    "status": false,
    "data": [],
    "critica": [
        {
            "cod": 0,
            "descricao": "Informe o [mshash] identificador do cliente aplicação [mshash]",
            "origem": "/mssuite/cancelamento_plano/api/v1/ws/formulario/get_protocolo",
            "trace": ""
        }
    ],
    "timestamp": "2019-04-22T11:15:09-03:00",
    "msg": "Informe o [mshash] identificador do cliente aplicação [mshash]"
}