Siprov API
Rumo TecnologiaSiprov
  • Início
  • Introdução
  • Configuração do Acesso
  • Teste
  • Erros
  • Ajuda
    • Nomenclaturas
    • Contato
  • Guia de Implementação
    • Apresentação
    • Autenticação
  • Referência da API
    • Introdução Técnica
      • Sobre
      • Autenticação
      • Empresa
      • Administração
        • Unidade (Loja)
        • Vendedor
      • Associado
        • Cartão de Crédito
      • Benefício
        • Cancelamento
        • Dependente
        • Tipo de Veículo
        • Benefício Veicular
        • Validação
        • Vencimento
        • Itens
        • Dependentes
      • Documentação/Vistoria
        • Tipos
        • Anexo
        • Documento
        • Foto
      • Financeiro
        • Cartão de Crédito
        • Forma de Pagamento
        • Tipo de Liquidação
        • Tipo de Título
        • Título
          • Boleto
          • Liquidar
          • Pagar
      • Evento
        • Orçamento
        • Situação de Evento
        • Tipo de Evento
      • Rede Credenciada
        • Clínica
        • Especialidade
        • Exame
        • Médico
        • Parceiro
          • Servico
          • Tipo
        • Região de Atendimento
      • Saúde
        • Marcação de Consulta
      • CRM
        • Lead
      • Integração Especial
        • Univers
        • Araújo
          • Empresas
      • 🔡Referência (Swagger)
      • ▶️Especificação (OpenAPI)
  • Gatilhos
    • Introdução
    • Referência
      • Acionamento
      • Benefício
      • Marcação de Consulta
      • Negócio de CRM
      • Evento
      • Help Desk
      • Rastreador
      • Título
      • Documentação/Vistoria
    • Especificação
  • Extras
    • 🔄Status
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Referência da API
  2. Introdução Técnica
  3. Benefício

Dependente

AnteriorCancelamentoPróximoTipo de Veículo

Isto foi útil?

Gravar Dependente

post

Grava o dependente, vinculando-o ao benefício indicado.

Atente-se para os seguintes campos, que tem opções fixas:

  • 'parentesco': CONJUGE | PAI | FILHO | IRMAO | AVO | TIO | SOBRINHO | PRIMO | NETO | SOGRO | OUTRO | PET_CANINO | PET_FELINO | PET_OUTROS | CUNHADO | GENRO | ENTEADO | PADRASTO
  • 'sexo': 'Feminino' ou 'Masculino'
Autorizações
Corpo
ativobooleanOpcional
codBeneficiointeger · int32 · mín: 1 · máx: 2147483647Obrigatório
codDependenteinteger · int32 · mín: 1 · máx: 2147483647Opcional

Este código é retornado pelo Siprov após gravar o dependente. Deve ser salvo pelo cliente e reenviado nas requisições seguintes. Se não for enviado, a requisição criará novo dependente.

cpfstringOpcional
dataNascimentostringOpcionalPattern: ^(\d{2}/\d{2}/\d{4})?$
identidadestring · máx: 45Opcional
nomestring · mín: 3 · máx: 100Opcional
numeroCartaoDescontostring · máx: 20Opcional
parentescostring · enumOpcionalValores possíveis:
planosinteger · int32[]Opcional

Informe os códigos de planos do dependente conforme negociação.

sexostring · enumOpcionalValores possíveis:
telefonestringOpcional
Respostas
200
Dependente gravado com sucesso
application/json
401
Não autorizado
text/plain
post
POST /siprov-api/ext/beneficio/dependente HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "ativo": true,
  "codBeneficio": 1,
  "codDependente": 1,
  "cpf": "text",
  "dataNascimento": "text",
  "identidade": "text",
  "nome": "text",
  "numeroCartaoDesconto": "text",
  "parentesco": "CONJUGE",
  "planos": [
    1
  ],
  "sexo": "Feminino",
  "telefone": "text"
}
{
  "codDependente": 1,
  "numeroCartaoDesconto": "text"
}