DOCUMENTAÇÃO CORPORATIVA
BuscarParticipante
Objetivo
Esse método tem como objetivo realizar uma busca de Participante (Destinatário) que esteja cadastrado em nossa base de dados.
Observações Importantes
- Não é possível realizar rajadas para esse método, a TARGET limita 50 requisições por minuto, aconselhamos requisições por demanda, caso o limite de 50 requisições seja ultrapassado, iremos bloquear as requisições apenas para o método que ultrapassou o limite durante 5 minutos.
Request
BuscaParticipanteRequest | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | QuantidadeItensPorPagina | int | Sim | Quantidades de Itens por Página | N/A |
2 | NumeroPagina | int | Sim | Número da Página | N/A |
3 | IdParticipante | int | Não | Id do Participante na base de dados da TARGET | N/A |
4 | CPFCNPJ | string | Sim | CPF ou CNPJ do Participante | N/A |
5 | Ativo | bool(true || false) | Sim | Se o Participante está Ativo ou Não na base de dados da TARGET | N/A |
Response
ParticipanteResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
2 | IdParticipante | int | Não | Id do Participante na base de dados da TARGET | N/A |
3 | IdDmTipoPessoa | int | Não | Tipo Pessoa | 1= Pessoa Física 2= Pessoa Jurídica |
4 | Nome | string | Sim | Nome do Participante | N/A |
5 | RazaoSocial | string | Sim | Razão Social do Participante | Caso seja um CNPJ |
6 | CPFCNPJ | string | Sim | CPF ou CNPJ do Participante | N/A |
7 | Endereco | string | Sim | Endereço do Participante | N/A |
8 | Bairro | string | Sim | Bairro do Participante | N/A |
9 | CEP | string | Sim | CEP do Participante | N/A |
10 | MunicipioCodigoIBGE | int | Não | Código IBGE do Município do Participante | N/A |
11 | RNTRC | string | Sim | RNTRC do Participante | Caso tenha |
12 | Ativo | bool(true || false) | Não | Informamos se o Participante está Ativo ou Não na base de dados da TARGET | N/A |
13 | string | Sim | E-mail do Participante | N/A | |
14 | Telefone | string | Sim | Telefone do Participante | N/A |
15 | TelefoneCelular | string | Sim | Telefone Celular do Participante | N/A |
ResultadoPaginadoResponse | |||||
Nº | Campo | Tipo | Obrigatório | Descrição | Observação |
---|---|---|---|---|---|
1 | Erro | ErroResponse - string | Não | Retorna o Erro | NULO em caso de sucesso |
2 | Itens | N/A | N/A | Itens | N/A |
3 | NumeroPagina | int | Sim | Número da Página | N/A |
4 | QuantidadeItensPorPagina | int | Sim | Quantidade de Itens por Página | N/A |
5 | QuantidadeTotalItens | int | Sim | Quantidade Total de Itens | N/A |
6 | QuantidadeTotalPaginas | int | Sim | Quantidade Total de Páginas | N/A |
Método
Abaixo, segue o método - 'BuscarParticipante'.
BuscarParticipanteRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br"> <soapenv:Header/> <soapenv:Body> <tms:BuscarParticipante> <tms:auth> <tms:Usuario>?</tms:Usuario> <tms:Senha>?</tms:Senha> <tms:Token>?</tms:Token> </tms:auth> <tms:buscaParticipante> <tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina> <tms:NumeroPagina>?</tms:NumeroPagina> <tms:IdParticipante>?</tms:IdParticipante> <tms:CPFCNPJ>?</tms:CPFCNPJ> <tms:Ativo>?</tms:Ativo> </tms:buscaParticipante> </tms:BuscarParticipante> </soapenv:Body> </soapenv:Envelope>
Buscar Participante
Abaixo, segue exemplo do método - 'BuscarParticipante'.
Exemplo - BuscaParticipante
Request <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header/> <soapenv:Body> <tms:BuscarParticipante> <tms:auth> <tms:Usuario>tms.exemplo</tms:Usuario> <tms:Senha>v0hXPrwerKblaBs=</tms:Senha> <tms:Token i:nil="true" /> </tms:auth> <tms:buscaParticipante> <tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina> <tms:NumeroPagina>1</tms:NumeroPagina> <tms:IdParticipante i:nil="true" /> <tms:CPFCNPJ>30844261000159</tms:CPFCNPJ> <tms:Ativo>true</tms:Ativo> </tms:buscaParticipante> </tms:BuscarParticipante> </soapenv:Body> </soapenv:Envelope>