Associado

AnteriorVendedor PróximoCartão de Crédito

Isto foi útil?

Pesquisar Associado

get

Retorna a lista de associados conforme parâmetros.

O associado poderá se repetir na lista em virtude de possuir mais de um benefício.

Necessário informar um dos seguintes parâmetros:

'codPessoa'
'nome'
'cpf' ou 'cnpj'
'dataCadastroInicial' e 'dataCadastroFinal'
'Data de Nascimento'
'situacaoBeneficio'

Autorizações

Parâmetros de consulta

nomestringOpcional

cpfstringOpcional

cnpjstringOpcional

cnpjEmpresastringOpcional

codPessoainteger · int32Opcional

codLojainteger · int32Opcional

codConsultorinteger · int32Opcional

codRepresentanteinteger · int32Opcional

dataCadastroInicialstringOpcionalExample: dd/MM/yyyyPattern: ^(\d{2}/\d{2}/\d{4})?$

dataCadastroFinalstringOpcionalExample: dd/MM/yyyyPattern: ^(\d{2}/\d{2}/\d{4})?$

dataNascimentostringOpcionalExample: dd/MM/yyyyPattern: ^(\d{2}/\d{2}/\d{4})?$

situacaoBeneficiostringOpcional

codPlanointeger · int32 · máx: 2147483647Opcional

ufstringOpcional

dataAtualizacaostringOpcional

Data referente a última atualização do associado ou benefício.

Example: dd/MM/yyyyPattern: ^(\d{2}/\d{2}/\d{4})?$

Respostas

200

Lista de benefícios

application/json

401

Não autorizado

text/plain

get

GET /siprov-api/ext/associado HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "categoriaCnh": "A",
  "chassi": "text",
  "codBeneficio": 1,
  "codPessoa": 1,
  "conjuge": "text",
  "cpfCnpj": "text",
  "cpfCnpjResponsavelFinanceiro": "text",
  "dadosAdicionais": [
    {
      "nome": "text",
      "valor": {}
    }
  ],
  "dataAdesao": "text",
  "dataAtivacao": "text",
  "dataCadastro": "text",
  "dataNascimento": "text",
  "email": "text",
  "endereco": {
    "bairro": "text",
    "cep": "text",
    "cidade": "text",
    "complemento": "text",
    "logradouro": "text",
    "numero": "text",
    "tipoEndereco": "text",
    "tipoLogradouro": "text",
    "uf": "text"
  },
  "enderecoResponsavelFinanceiro": {
    "bairro": "text",
    "cep": "text",
    "cidade": "text",
    "complemento": "text",
    "logradouro": "text",
    "numero": "text",
    "tipoEndereco": "text",
    "tipoLogradouro": "text",
    "uf": "text"
  },
  "faturarParaEmpresa": true,
  "idade": 1,
  "identidade": "text",
  "nomeEmpresa": "text",
  "nomeMae": "text",
  "nomePai": "text",
  "nomePessoa": "text",
  "nomeResponsavelFinanceiro": "text",
  "numeroCartaoDesconto": "text",
  "numeroCnh": "text",
  "placa": "text",
  "planos": [
    {
      "codPlano": 1,
      "nome": "text",
      "valor": 1
    }
  ],
  "sequencial": 1,
  "sexo": "text",
  "situacao": "text",
  "telefoneCelular": "text",
  "telefoneFixo": "text",
  "tipoBeneficio": "text",
  "tipoSituacao": "text"
}

Gravar Associado

post

Grava os dados básicos da pessoa, vinculando o cadastro pelo CPF/CNPJ.

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

'natureza': 'F' ou 'J'
'sexo': 'Feminino' ou 'Masculino'
'telefones' -> 'tipo': 'Fixo' ou 'Celular'

Autorizações

Corpo

codLojainteger · int32Opcional

codPessoainteger · int32Opcional

codigoIntegracaostringOpcional

cpfCnpjstringOpcional

dataExpedicaostringOpcionalPattern: ^(\d{4}\-\d{2}\-\d{2})?$

dataNascimentostringOpcionalPattern: ^(\d{4}\-\d{2}\-\d{2})?$

emailstringOpcional

identidadestring · máx: 25Opcional

naturezastring · enumOpcionalValores possíveis:

nomeFantasiastring · máx: 100Opcional

nomePessoastring · mín: 1 · máx: 250Opcional

observacaostringOpcional

orgaoExpedidorstring · máx: 20Opcional

sexostring · enumOpcionalValores possíveis: