Protocolos
Atualizar Cliente
Cadastra um novo cliente, ou atualiza suas informações.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/atualizadadoscliente
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Carteira do beneficiário |
| usuario_nome | Não | string | Até 60 caracteres | Nome do beneficiário |
| usuario_email | Não | email@dominio.xxx | E-mail do beneficiário | |
| usuario_telefone | Não | string | Até 20 caracteres | Telefone do beneficiário |
| ind_atualiza | Sim | string | 1 caractere (S - SIM / N - NÃO) | Indicador de atualização em caso do usuário já estar cadastrado |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| codigo_cliente | Sim | int | 1 a 10 dígitos | Código do cliente cadastrado/atualizado |
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
Busca protocolo
Busca as informações referentes ao protocolo solicitado.
GET|HEAD http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/buscaprotocolo
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| numero_protocolo | Sim | string | 999999.9999.99.99.999999 | Número do protocolo. |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
| descricao | Sim | string | Até 4000 caracteres. | Descrição do protocolo, |
| observacao | Sim | string | Até 4000 caracteres. | Observações inseridas no protocolo. |
| origem_protocolo | Sim | int | 1 a 2 dígitos. | Sistema que originou a abertura do protocolo. |
| sub_produto | Sim | int | 1 a 5 dígitos. | Tipo da solicitação do protocolo |
| classificacao | Sim | int | 1 a 5 dígitos. | Classificação do protocolo |
| data_fim_atend | Sim | date | Y-m-d HH24:MM:SS | Data de encerramento do protocolo |
Encerrar Protocolo
Encerra o protocolo, caso ele esteja em aberto.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/encerraprotocolo
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| numero_protocolo | Sim | string | 999999.9999.99.99.999999 | Número do protocolo |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
Encerrar Protocolo Observação
Encerra o protocolo enviando alguma observação a ser armazenada.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/encerraprotocoloobservacao
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| numero_protocolo | Sim | string | 999999.9999.99.99.999999 | Número do protocolo |
| observacao | Sim | string | Até 1000 caracteres | Observação do encerramento do protocolo |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
Envia Anexo
Envia um anexo a ser adicionado no protocolo.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/enviaanexoprotocolo
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| numero_protocolo | Sim | string | 999999.9999.99.99.999999 | Número do protocolo |
| nome_anexo | Sim | string | Até 70 caracteres | Nome do anexo (com extensão) |
| anexo | Sim | body | Este campo deve ser enviado no CORPO da requisição POST | Anexo do protocolo |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
Gerar Número Protocolo
Gera um novo protocolo para o cliente.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/geraprotocolo
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Carteira do beneficiário |
| origem_protocolo | Sim | int | 1 a 2 dígitos (8 - App / 9 - Portal) | Origem da criação do novo protocolo |
| sub_produto | Não | int | 1 a 5 dígitos | Tipo da solicitação realizada pelo beneficiário |
| sub_produto_classificacao | Não | int | 1 a 5 dígitos | Classificação da solicitação realizada |
| descricao | Sim | string | Até 1000 caracteres | Descrição do protocolo |
| observacao | Sim | string | Até 1000 caracteres | Observação do protocolo |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| nr_protocolo | Sim | string | 99999999999999999999 | Número do protocolo gerado para o cliente |
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |
| nr_protocolo_pontos | Sim | string | 999999.9999.99.99.999999 | Número do protocolo gerado para o cliente (com pontos) |
Registrar Atividade
Cadastra um novo trâmite executado pelo cliente.
POST http://webservice.unimedsc.coop.br/api/protocolorn/protocolosrn395/registraatividade
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| numero_protocolo | Sim | string | 999999.9999.99.99.999999 | Número do protocolo |
| descricao_atividade | Sim | string | Até 1000 caracteres | Descrição da atividade realizada no protocolo |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| mensagem_erro | Sim | string | Até 500 caracteres. | Caso a operação falhe, a mensagem de erro será retornada neste parâmetro. |