Localizar Usuários

Serviço que busca por usuários de acordo com o filtro estabelecido.

Parâmetros de Cabeçalho

Parâmetro Formato Obrigatório? Descrição
t String sim O Token que identifica a Aplicação.

Parâmetros de Query

Parâmetro Formato Obrigatório? Descrição
query String sim O termo de busca, que pode ser uma parte do nome, parte do e-mail, ou CPF/CNPJ completo sem formatação.

Retorno da Chamada

Raiz: respostaPortalVO

Atributo Tipo Descrição
ok boolean Indica se a requisição foi processada com sucesso.
chaveRetorno String Chave de internacionalização, para exibição da mensagem de retorno em sistemas com suporte à I18n.
mensagemRetorno String Mensagem de retorno do servidor para o status da requisição.
statusHttp int Indica um status de retorno para a requisição, de acordo com as convenções do HTTP.
entidades Genérico Pode comportar uma lista de objetos, ou um objeto único, que contém as informações solicitadas pelo serviço. As informações específicas do serviço serão detalhadas em uma tabela separada (tabela Entidade).
tokenRenovacao String Quando o token da aplicação expira, a primeira chamada após o token expirar conterá um token de renovação, para que seja possível renovar o token de autorização da aplicação sem que seja necessária uma nova prova de credenciais.
validadeToken timestamp A data até a qual o token utilizado é válido.
horarioRetorno timestamp A hora do servidor no momento em que foi processada a resposta.

Entidade

Raiz: usuarioPortalVO

Atributo Tipo Descrição
username String O nome de usuário (login) do usuário.
nome String Nome completo (ou Razão Social) do Usuário.
emailPrincipal String O endereço de e-mail primário do usuário.
apelido String Como o usuário deseja ser chamado.
prefixoTratamento String Um prefixo de tratamento para o usuário (ex.: Sr., Sra., Dr.).
enderecos EnderecoPortalVO (lista, atributos detalhados em tabela abaixo) Lista com os endereços registrados para o usuário.
telefones TelefonePortalVO (lista, atributos detalhados em tabela abaixo) Lista com os telefones registrados para o usuário.
papeis PapelPortalVO (lista, atributos detalhados em tabela abaixo) Lista com os papeis do usuário na aplicação identificada.
preferencias PreferenciasUsuarioVO (lista, atributos detalhados em tabela abaixo) Lista com as preferencias do usuário do portal.
pessoaFisica PessoaFisicaPortalVO (atributos detalhados em tabela abaixo) Dados de Pessoa Física do usuário. Não será preenchido se o usuário for uma Pessoa Jurídica.
pessoaJuridica PessoaJuridicaPortalVO (atributos detalhados em tabela abaixo) Dados de Pessoa Jurídica do usuário. Não será preenchido se o usuário for uma Pessoa Física.
saldoConta SaldoContaPortalVO (atributos detalhados em tabela abaixo) Saldo da conta do usuário.
parceiro boolean Informa se o usuário é um parceiro do Portal.
informacoesAplicacao InormacoesAplicacaoPortalVO (atributos detalhados em tabela abaixo) Informações relativas à aplicação que realizou a chamada.

EnderecoPortalVO

Atributo Tipo Descrição
nomeCidade String O nome da Cidade.
nomeCidadeI18n String Chave de internacionalização do nome da Cidade.
nomeEstado String O nome do Estado.
nomeEstadoI18n String Chave de internacionalização do nome do Estado.
nomePais String O nome do País.
nomePaisI18n String Chave de internacionalização do nome do País.
nomeBairro String Nome do Bairro do endereço.
logradouro String Logradouro do endereço.
tipoLogradouro String / TipoLogradouroPortalEnum Valores possíveis: RUA, AVENIDA, RODOVIA, ESTRADA, PARQUE, PRACA, LARGO, TRAVESSA, GALERIA, ALAMEDA, CAMINHO, QUILOMETRO, ESTACAO, AEROPORTO, VILA, PRAIA, QUADRA, APARTAMENTO, BECO, BLOCO, ESCADINHA, FAZENDA, FORTALEZA, LADEIRA, QUINTA, SUPERQUADRA, VIADUTO.
codigoPostal String Código Postal do Endereço (CEP).
complemento String Instruções para localização do endereço.
referencia String Referência (Ponto Notável) para localização do endereço.
enderecoPrincipal boolean Indica se este é o endereço primário do usuário.

PessoaFisicaPortalVO

Atributo Tipo Descrição
cpf String Cadastro de Pessoa Física (CPF).
dataNascimento Date Data de nascimento da pessoa física.
genero String / GeneroPortalEnum Valores possíveis: MASCULINO, FEMININO, NAOESPECIFICADO.
estadoCivil String / EstadoCivilPortalEnum Valores possíveis: SOLTEIRO, CASADO, DIVORCIADO, VIUVO.

PessoaJuridicaPortalVO

Atributo Tipo Descrição
cnpj String Cadastro Nacional de Pessoa Jurídica (CNPJ).
nomeFantasia String Nome Fantasia da Pessoa Jurídica.
dataFundacao Date Data em que a Pessoa Jurídica foi fundada.
nomeTitular String Nome completo do titular da Pessoa Jurídica.
cpfTitular String CPF do Titular da Pessoa Jurídica.
dataNascimentoTitular Date Data em que o titular da Pessoa Jurídica nasceu.
titulares TitularPortalVO [ ] (atributos detalhados em tabela abaixo) Lista de titulares da pessoa jurídica.

TitularPortalVO

Atributo Tipo Descrição
nome String Nome do titular da Pessoa Jurídica.
cpf String CPF do titular da Pessoa Jurídica.
email String E-mail do titular da Pessoa Jurídica.

SaldoContaPortalVO

Atributo Tipo Descrição
nome String Nome do usuário da sessão.
nomeUsuario String Nome de Usuário (login) do usuário da sessão.
identificadorSessaoSSO String Identificador da Sessão do Portal, ou Token de Autorização do usuário da sessão.
aliasCarteira String Um rótulo para a Conta selecionada na sessão.
nomeDonoConta String Nome do usuário que é dono da conta da sessão.
nomeUsuarioDonoConta String Nome de Usuário (login) do usuário que é dono da conta da sessão.
tipoRelacionamento String / InscricaoGrupoPortalEnum Define o tipo de relacionamento que o usuário da sessão possui com o dono da conta selecionada. Valores possíveis: CRIADOR, ADMINISTRADOR, MEMBRO, CONVIDADO, SOLICITANTE, NAOINSCRITO, BLOQUEADO, RECUSADO
saldoUsuario BigDecimal Saldo da Conta disponível para o usuário da sessão.
totalCota BigDecimal Se uma cota limitada dos créditos da conta foi definida para o usuário da sessão, este atributo retorna o valor desta cota (a cota é mensal).
totalGastoNoPeríodo String Quantos créditos já foram gastos pelo usuário no período, utilizando esta conta.
compartilhamento boolean Indica se a conta sendo utilizada é uma conta compartilhada (cujo dono não é o usuário que a está utilizando).
carteiraPessoal boolean Indica se o usuário e o dono da conta são a mesma pessoa.
cota boolean Indica se existe uma cota mensal limitada definida para o usuário.
podeTrocarConta boolean Indica se o usuário está autorizado a fazer troca de conta.
possuiCompartilhamentosPendentesOuAtivos boolean Indica se há algum convite de relacionamento pendente para o usuário.
posPago boolean Indica se a conta é Pós-paga (true) ou Pré-paga (false).

InformacoesAplicacaoPortalVO

Atributo Tipo Descrição
nome String Nome da aplicação.
descricao String Descrição da aplicação.
chave String Chave única que identifica a aplicação no Portal.
urlLogomarca String URL a partir da qual a logomarca da aplicação pode ser recuperada.
endereco String URL para acessar a aplicação.
nomeUsuarioMantenedor String Nome do Usuário que cadastrou a aplicação (para chamadas originárias de Service Providers do Portal este atributo nunca virá preenchido).
chavesOperacoes String (lista) Informa a chave de todas as operações oferecidas pela aplicação no portal.