Método getMyRecords

Método getMyRecords

Finalidade

Você pode usar o método getMyRecords para buscar os dados pelo proprietário do token de autenticaçãoespecificado na solicitação de API.

URL de solicitação

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

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

Parâmetros de solicitação

ParâmetroTipo de dadosDescrição
authtoken*StringSequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho.
scope*StringEspecifique o valor como crmapi
selectColumnsStringPara selecionar os campos obrigatórios do módulo de CRM.
Formato: Module(optional columns)
Examplo: leads(Last Name,Website,Email) OU All
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]
sortColumnStringStringVocê pode selecionar um dos campos no CRM para classificar os dados.
Ex: sortColumnString=Company
Aqui, a classificação dos dados acontecerá com base no campo Empresa
sortOrderStringStringOrdem de classificação: asc ou desc
Se você usar o parâmetro sortColumnString, os dados são classificados em ordem crescente, por padrão.
lastModifiedTimeaaaa-MM-dd HH:mm:ssValor padrão: null
Se você especificar a hora, os dados criados/modificados serão buscados depois da hora definida.
newFormatNúmero inteiro (1 ou 2)newFormat=1: para excluir campos com valor "null" ao buscar dados da sua conta no CRM.
NewFormat=2: para incluir campos com valor "null" ao buscar dados da sua conta no CRM.
versionNúmero inteiro

version = 1:(valor padrão) irá buscar respostas com base na implementação da API anterior, ou seja, antes dos aprimoramentos feitos.
version = 2: irá buscar respostas com base na implementação API mais recente.

A versão atual é 4.

* – 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.

Códigos de erro

Por favor, consulte Códigos de erro.

Notas adicionais

  • Ao recuperar os dados de sua conta Zoho CRM, a segurança baseada em função (Funções, Perfis, Segurança em nível de campo e Regras de compartilhamento de dados) é aplicada. Para as configurações de segurança baseada em função, consulte Administração de Segurança.
  • fromIndex e toIndex são parâmetros opcionais. Por padrão, fromIndex é 1 e toIndex é 20.
  • sortColumnString and sortOrderString também são parâmetros opcionais
  • O valor para o parâmetro lastModifiedTime deve estar no formato aaaa-MM-dd HH:mm:ss

Exemplos

Para buscar dados de lead no Zoho CRM

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

Para buscar dados de outros módulos, substitua Leads por Contas, Contatos, Potenciais etc.

Para obter mais de 200 registros

Por padrão, você pode buscar 20 registros por lote. No entanto, usando o parâmetro toIndex, você pode buscar até 200 registros por lote. Se você deseja extrair mais de 200 registros, siga as etapas abaixo:

Iteration 1: fromIndex=1&toIndex=200
Iteration 2: fromIndex=201&toIndex=400

Para buscar leads com o nome "Empresa" em ordem crescente

sortColumnString=Company&sortOrderString=asc

Para buscar leads com o nome "Empresa" em ordem decrescente

sortColumnString=Company&sortOrderString=desc

Para buscar leads sem especificar o parâmetro newFormat

Nota:

  • Quando não há nenhuma especificação sobre o formato de resposta, o valor padrão "1" será atribuído para o parâmetro newFormat, ou seja, newFormat = 1

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)

Isso retornará uma resposta como abaixo:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>

Para buscar leads com "newFormat=2"

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)

Isso retornará uma resposta como abaixo:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>
</Leads>

Para obter os primeiros 25 leads do Zoho CRM

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&fromIndex=1&toIndex=25

Para buscar leads com o parâmetro "lastModifiedTime"

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23

Nota:

  • Se você especificar a hora, os dados modificados serão buscados após a hora definida.

Para selecionar todos os campos dos leads com o parâmetro newFormat=1

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All

Nota:

  • Este retornará todos os campos que contêm valores.

Para selecionar todos os campos de leads com newFormat=2

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All

Nota:

  • Este retornará todos os campos, incluindo campos de valor null.

Para buscar leads com parâmetros lastModifiedTime, fromIndex e toIndex

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23 &fromIndex=1&toIndex=25

Programa de teste

Você pode usar o programa anexo para executar e testar o funcionamento do método getMyRecords em seu ambiente Java.

O programa Java contém o seguinte:

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

Share this post : FacebookTwitter

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

Escreva para nós: support@zohocrm.com