CRM Help

Método getSearchRecordsByPDC

Finalidade

Você pode usar esse método para pesquisar valores com base em colunas predefinidas e campos de pesquisa personalizada.

URL de solicitação

Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi

Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi

Parâmetros de solicitação

ParâmetroTipo de dadosDescrição
authotoken*StringSequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho.
scope*StringEspecifique crmapi como scope
selectColumns*StringAll ou module(field 1,field 2,field 3, field n...)
Examplo: leads(Last Name,Website,Email)
fromIndexNúmero inteiroValor Padrão – 1
toIndexNúmero inteiroValor padrão – 20
Valor de intervalo máximo – 200
[Valor de intervalo máximo = toIndex – fromIndex]
searchColumn*String

Especifique a coluna de pesquisa predefinda (consulte Colunas predefinidas padrão, abaixo).

Nota: você também pode pesquisar valores com base em campos de pesquisa personalizada.

searchValue*StringEspecifique o valor a ser pesquisado.
newFormatNúmero inteironewFormat=1: para excluir campos com valores "null" ao inserir dados de sua conta CRM.
newFormat=2: para incluir campos com valores "null" ao inserir dados de sua conta CRM.
versionNúmero inteiroversion = 1: (valor padrão) Irá buscar respostas com base na implementação API anterior, ou seja, antes dos aprimoramentos feitos.
version = 2: irá buscar respostas com base na implementação API mais recente.

* – Parâmetro obrigatório

Nota:

  • Consulte a página de Notas de versão para saber mais sobre as melhorias feitas na implementação API.

Colunas predefinidas padrão

MóduloCampos
Leads
  • E-mail
Contas
  • accountid
  • accountname
Contatos
  • contactid
  • accountid
  • vendorid
  • E-mail
Potenciais
  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname
Campanhas
  • campaignid
  • campaignname
Casos
  • caseid
  • productid
  • accountid
  • potentialid
Soluções
  • solutionid
  • productid
Produtos
  • productid
  • vendorid
  • productname
Ordem de compra
  • purchaseorderid
  • contactid
  • vendorid
Cotações
  • quoteid
  • potentialid
  • accountid
  • contactid
Ordens de venda
  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid
Faturas
  • invoiceid
  • accountid
  • salesorderid
  • contactid
Fornecedores
  • vendorid
  • vendorname
Tarefas
  • taskid
Eventos
  • eventid
Notas
  • notesid

Exemplos

Leads com coluna e-mail iniciando de 20 a 200

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi&fromIndex=20&toIndex=200&selectColumns=leads(Last Name,Website,Email)&searchColumn=email &searchValue=abc@testingdomain.com

Leads com coluna e-mail

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=email
&searchValue=test@test.com

Leads com coluna campaignid

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=campaignid
&searchValue=2000000017011

Contatos com coluna vendorid

https://crm.zoho.com/crm/private/xml/Contacts/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Contacts(Contact Owner,Lead Source,First Name,Last Name,Account Name)
&searchColumn=vendorid
&searchValue=2000000017022

Produtos com coluna vendorid

https://crm.zoho.com/crm/private/xml/Products/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Products(Product Owner,Product Name,Product Code,Manufacturer,Product Category,Unit Price)
&searchColumn=vendorid
&searchValue=2000000017022

Ordens de venda com coluna accountid

https://crm.zoho.com/crm/private/xml/SalesOrders/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=SalesOrders(SO Number,Subject,Due Date,Carrier,Status)
&searchColumn=accountid
&searchValue=2000000017003

Pesquise registros usando campos de pesquisa personalizada

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&searchColumn=ProductLookup_ID
&searchValue=108149000062016

Isso retornará uma resposta como abaixo:

<Leads>
<row no="1">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">Scott</FL>
<FL val="SMCREATORID">1081490000078001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">1081490000078001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-10-27 15:18:11</FL>
<FL val="Modified Time">2014-11-26 12:53:13</FL>
<FL val="Last Activity Time">2014-11-26 12:53:13</FL>
<FL val="ProductLookup_ID">108149000062016</FL>
<FL val="ProductLookup">CPU</FL>
</row>
</Leads>

Programa de teste

Você pode usar o programa anexado para executar e testar o funcionamento do método getSearchRecordsByPDC em seu ambiente Java.
O programa Java contém o seguinte:

  • O formato de geração do token de autenticação
  • Os parâmetros e seus valores
  • Uso real do método

Clique aqui para fazer download do programa

Share this post : FacebookTwitter

Ainda não consegue encontrar o que você está procurando?

Escreva para nós: support@zohocrm.com