Atualização Cadastral
Atualiza contato
Atualiza os dados de contato do beneficiário.
POST https://webservice.unimedgoiania.coop.br/api/sgumobile/atualizacaocadastral/atualizacontato
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Cartão do beneficiário |
| usuario_telefone | Não | string | (99)999999999 | Telefone do beneficiário |
| usuario_celular | Não | string | (99)999999999 | Celular do beneficiário |
| usuario_fax | Não | string | (99)999999999 | Fax do beneficiário |
| usuario_email | Não | [email protected] | E-mail do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| confirma_operacao | Sim | int |
|
Confirmação da operação | ||||
| mensagem_erro | Sim | string | livre | Mensagem contendo o erro ocorrido na operação |
Atualiza endereço
Insere ou atualiza um endereço do beneficiário.
POST https://webservice.unimedgoiania.coop.br/api/sgumobile/atualizacaocadastral/atualizaendereco
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição | ||
|---|---|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Cartão do beneficiário | ||
| tipo_endereco | Sim | string |
|
Tipo do endereço (preenchido em caso de inclusão) | ||
| endereco_ind | Sim | int | 1 a 2 dígitos | Código do endereço (preenchido em caso de atualização) | ||
| endereco_cep | Sim | string | 99999999999 (sem hífen) | CEP do endereço | ||
| endereco_logradouro | Sim | string | Até 100 caracteres | Logradouro do endereço | ||
| endereco_numero | Sim | string | Até 5 caracteres | Número do endereço | ||
| endereco_complemento | Sim | string | Até 30 caracteres | Complemento do endereço | ||
| endereco_cidade | Sim | string | Até 72 caracteres | Nome da cidade | ||
| endereco_bairro | Sim | string | Até 40 caracteres | Bairro do endereço | ||
| endereco_estado | Sim | string | 2 caracteres | Estado do endereço | ||
| endereco_ponto_referencia | Sim | string | Até 40 caracteres | Ponto de referência do endereço | ||
| endereco_caixa_postal | Sim | string | Até 30 caracteres | Código de caixa postal do endereço | ||
| endereco_ind_correspondencia | Sim | string |
|
Indicador de recebimento de correspondência | ||
| endereco_ind_fatura | Sim | string |
|
Indicador de recebimento de fatura |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| confirma_operacao | Sim | int |
|
Confirmação da operação | ||||
| mensagem_erro | Sim | string | livre | Mensagem contendo o erro ocorrido na operação |
Buscar CEP
Buscar os dados do CEP.
GET|HEAD https://webservice.unimedgoiania.coop.br/api/sgumobile/atualizacaocadastral/buscacep
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| cep | Sim | string | 99999999999 (sem hífen) | CEP do endereço |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| confirma_operacao | Sim | int |
|
Confirmação da operação | ||||
| mensagem_erro | Sim | string | livre | Mensagem contendo o erro ocorrido na operação |
Buscar dados usuário
Buscar os dados cadastrais do beneficiário.
GET|HEAD https://webservice.unimedgoiania.coop.br/api/sgumobile/atualizacaocadastral/buscadadosusuario
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Cartão do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| situacao | Sim | string |
|
Indica se o beneficiário possui alteração pendente. | ||||
| contrato | Sim | int | Até 10 dígitos | Número do contrato do beneficiário | ||||
| cod_pessoa | Sim | int | Até 10 dígitos | Código da pessoa do beneficiário no sistema de gestão | ||||
| codigo_usuario_portal | Sim | int | Até 10 dígitos | Código do usuário no portal de beneficiários | ||||
| lote | Sim | int | Até 10 dígitos | Código do lote da operação aberto | ||||
| movimento | Sim | int | Até 10 dígitos | Código do movimento aberto | ||||
| cart_unimed | Sim | int | Até 4 dígitos | Código da Unimed no cartão do beneficiário | ||||
| cart_contrato | Sim | int | Até 4 dígitos | Código do contrato no cartão do beneficiário | ||||
| cart_cod_bnf | Sim | int | Até 6 dígitos | Código identificador do cartão do beneficiário | ||||
| cart_cod_dependente | Sim | int | Até 2 dígitos | Código do dependente no cartão do beneficiário | ||||
| nome | Sim | string | Até 120 caracteres | Nome completo do beneficiário | ||||
| data_nasc | Sim | date | DD/MM/YYYY | Data de nascimento do beneficiário | ||||
| nome_mae | Sim | string | Até 70 caracteres | Nome da mãe do beneficiário | ||||
| cpf | Sim | string | 11 dígitos (somente números) | CPF do beneficiário | ||||
| permite_atualizar | Sim | string |
|
Permite o usuário atualizar seu cadastro via aplicativo | ||||
| [endereco]pes_cod | Sim | int | Até 10 dígitos | Código da pessoa responsável pelo endereço | ||||
| [endereco]codigo | Sim | int | Até 10 dígitos | Código identificador do endereço | ||||
| [endereco]tipo | Sim | string | Até 15 caracteres | Descrição do tipo do endereço | ||||
| [endereco]cep | Sim | string | 99999999999 (sem hífen) | CEP do endereço | ||||
| [endereco]logradouro | Sim | string | Até 100 caracteres | Descrição do logradouro | ||||
| [endereco]numero | Sim | string | Até 5 caracteres | Número do endereço | ||||
| [endereco]complemento | Sim | string | Até 30 caracteres | Complemento do endereço | ||||
| [endereco]estado | Sim | string | 2 caracteres | Estado do endereço | ||||
| [endereco]cidade | Sim | string | Até 50 caracteres | Nome da cidade do endereço | ||||
| [endereco]bairro | Sim | string | Até 40 caracteres | Bairro do endereço | ||||
| [endereco]ponto_referencia | Sim | string | Até 40 caracteres | Ponto de referência do endereço | ||||
| [endereco]caixa_postal | Sim | string | Até 30 caracteres | Caixa postal do endereço | ||||
| [endereco]ind_correspondencia | Sim | string |
|
Indica se o endereço recebe correspondência | ||||
| [endereco]ind_fatura | Sim | string |
|
Indica se o endereço recebe fatura | ||||
| [contato]telefone | Sim | string | (99)999999999 | Telefone do beneficiário | ||||
| [contato]celular | Sim | string | (99)999999999 | Celular do beneficiário | ||||
| [contato]fax | Sim | string | (99)999999999 | Fax do beneficiário | ||||
| [contato]email | Sim | [email protected] | E-mail do beneficiário | |||||
| [contato]codigo | Sim | int | Até 2 dígitos | Código identificador do contato no sistema de gestão | ||||
| confirma_operacao | Sim | int |
|
Confirmação da operação | ||||
| mensagem_erro | Sim | string | livre | Mensagem contendo o erro ocorrido na operação |
Excluir endereço
Exclui um endereço do beneficiário.
POST https://webservice.unimedgoiania.coop.br/api/sgumobile/atualizacaocadastral/excluiendereco
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| usuario_cartao | Sim | string | 99999999999999999 | Cartão do beneficiário |
| endereco_ind | Sim | int | 1 a 2 dígitos | Código do endereço a ser excluído |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| confirma_operacao | Sim | int |
|
Confirmação da operação | ||||
| mensagem_erro | Sim | string | livre | Mensagem contendo o erro ocorrido na operação |