DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

  1. Não é possível realizar rajadas para esse método, a TARGET limita uma quantidade X de requisições por minuto, aconselhamos requisições por demanda.

Request

BuscaParticipanteRequest
CampoTipoObrigatórioDescriçãoObservação
1QuantidadeItensPorPaginaintSimQuantidades de Itens por PáginaN/A
2NumeroPaginaintSimNúmero da PáginaN/A
3IdParticipanteintNãoId do Participante na base de dados da TARGETN/A
4CPFCNPJstringSimCPF ou CNPJ do ParticipanteN/A
5Ativobool(true || false)SimSe o Participante está Ativo ou Não na base de dados da TARGETN/A

Response

ParticipanteResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de sucesso
2IdParticipanteintNãoId do Participante na base de dados da TARGETN/A
3IdDmTipoPessoaintNãoTipo Pessoa1= Pessoa Física
2= Pessoa Jurídica
4NomestringSimNome do ParticipanteN/A
5RazaoSocialstringSimRazão Social do ParticipanteCaso seja um CNPJ
6CPFCNPJstringSimCPF ou CNPJ do ParticipanteN/A
7EnderecostringSimEndereço do ParticipanteN/A
8BairrostringSimBairro do ParticipanteN/A
9CEPstringSimCEP do ParticipanteN/A
10MunicipioCodigoIBGEintNãoCódigo IBGE do Município do ParticipanteN/A
11RNTRCstringSimRNTRC do ParticipanteCaso tenha
12Ativobool(true || false)NãoInformamos se o Participante está Ativo ou Não na base de dados da TARGETN/A
13EmailstringSimE-mail do ParticipanteN/A
14TelefonestringSimTelefone do ParticipanteN/A
15TelefoneCelularstringSimTelefone Celular do ParticipanteN/A
ResultadoPaginadoResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de sucesso
2ItensN/AN/AItensN/A
3NumeroPaginaintSimNúmero da PáginaN/A
4QuantidadeItensPorPaginaintSimQuantidade de Itens por PáginaN/A
5QuantidadeTotalItensintSimQuantidade Total de ItensN/A
6QuantidadeTotalPaginasintSimQuantidade Total de PáginasN/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>


Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <BuscarParticipanteResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
         <BuscarParticipanteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Erro i:nil="true"/>
            <Itens>
               <ParticipanteResponse>
                  <Erro i:nil="true"/>
                  <IdParticipante>3461</IdParticipante>
                  <IdDmTipoPessoa>2</IdDmTipoPessoa>
                  <Nome>OZIEL TEIXEIRA JUNIOR</Nome>
                  <RazaoSocial>OZIEL TEIXEIRA JUNIOR</RazaoSocial>
                  <CPFCNPJ>30844261000159</CPFCNPJ>
                  <Endereco>TRAVESSA VICENTE BENEDITO NOGUEIRA, 173</Endereco>
                  <Bairro>Centro</Bairro>
                  <CEP>37589000</CEP>
                  <MunicipioCodigoIBGE>3167400</MunicipioCodigoIBGE>
                  <RNTRC i:nil="true"/>
                  <Ativo>false</Ativo>
                  <Email i:nil="true"/>
                  <Telefone i:nil="true"/>
                  <TelefoneCelular i:nil="true"/>
               </ParticipanteResponse>
            </Itens>
            <NumeroPagina>1</NumeroPagina>
            <QuantidadeItensPorPagina>20</QuantidadeItensPorPagina>
            <QuantidadeTotalItens>1</QuantidadeTotalItens>
            <QuantidadeTotalPaginas>1</QuantidadeTotalPaginas>
         </BuscarParticipanteResult>
      </BuscarParticipanteResponse>
   </s:Body>
</s:Envelope>
  • No labels