Método getRecords
Índice
- Finalidade
- Solicitar URL
- Parâmetros de solicitação
- Erros de captura
- Exemplos
- Para buscar todas as contas no formato JSON classificadas por nome de conta (em ordem decrescente) de 20 até 200
- Para buscar todas as contas em formato XML modificado/criado após 2008-05-27 00:00:00
- Para buscar oportunidades com versão = 1
- Para buscar oportunidades com versão = 2
- Para buscar oportunidades sem especificar o parâmetro newFormat
- Para buscar com newFormat=2
- Para chamar com fromIndex=1, toIndex=25
- Para chamar com lastModifiedTime
- Para selecionar todos os campos das oportunidades com newFormat=1
- Para selecionar todos os campos das oportunidades com newFormat=2
- Para chamar com lastModifiedTime, fromIndex e toIndex
- Para chamar com lastModifiedTime, fromIndex e toIndex (para o módulo Contas)
- Testar programa
Finalidade
Você pode usar o método getRecords para buscar todos os dados de usuários especificados na solicitação da API.
Solicitar URL
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Parâmetros de solicitação
| Parâmetro | Tipo de dados | Descrição |
| authtoken* | Sequência | Sequências alfanuméricas criptografadas para autenticar suas credenciais do Zoho. |
| escopo* | Sequência | Especifique o valor como crmapi |
| selectColumns | Sequência | Módulo (colunas opcionais), ou seja, oportunidades (Sobrenome, Website, E-mail) OU Todos |
| fromIndex | Número inteiro | Valor padrão - 1 |
| toIndex | Número inteiro | Valor padrão - 20 Valor máximo de intervalo - 200 [Valor máximo de intervalo = toIndex - fromIndex] |
| sortColumnString | Sequência | Se você usar o parâmetro sortColumnString, por padrão, os dados são classificados em ordem crescente. |
| sortOrderString | Sequência | Valor padrão - asc Se quiser classificar em ordem decrescente, será necessário passar sortOrderString=desc. |
| lastModifiedTime | DateTime | Valor padrão: nulo Se você especificar o tempo, os dados modificados serão pesquisados após o tempo configurado. |
| newFormat | Número inteiro | newFormat=1: Para excluir campos com valores "nulos" ao inserir dados pela conta CRM. newFormat=2:Para incluir campos com valores "nulos" ao inserir dados pela conta CRM. |
| versão | Número inteiro | versão = 1: (Valor padrão) Isso buscará respostas com base na implementação anterior de API, ou seja, antes que os aprimoramentos sejam feitos. versão = 2: Isso vai buscar respostas com base na implementação de API mais recente. |
* - Parâmetro obrigatório
Nota:
- Consulte a página Notas da versão para saber mais sobre os aprimoramentos feitos na implementação da API.
Erros de captura
A API do CRM oferece códigos de erro exclusivos para solucionar problemas facilmente em seu programa durante a sincronização de dados entre o CRM e seu aplicativo. Para saber mais sobre vários códigos de erro e a definição correspondente, consulte os Códigos de erro.
Notas adicionais
- Ao recuperar dados da sua conta Zoho CRM, as configurações de segurança de nível de campo do usuário é aplicada. Portanto, para buscar todos os dados de usuários, use a ID de usuário com a função mais alta (por exemplo: CEO) e o perfil (por exemplo: Administrador).
- fromIndex e toIndex são parâmetros opcionais. Por padrão, fromIndex é 1 e toIndex é 20.
- sortColumnString e 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 todas as contas no formato JSON classificadas por nome de conta (em ordem decrescente) de 20 até 200
Formato do URL:
Para buscar todas as contas em formato XML modificado/criado após 2008-05-27 00:00:00
Formato do URL:
Para buscar oportunidades com versão = 1
Para buscar oportunidades com versão = 2
Isso retornará uma resposta como abaixo:
Para buscar oportunidades sem especificar o parâmetro newFormat
Nota:
- Quando não houver especificação sobre o formato de resposta, o valor padrão "1" será atribuído ao parâmetro newFormat, ou seja, newFormat = 1
Isso retornará uma resposta como abaixo:
Para buscar com newFormat=2
Para chamar com fromIndex=1, toIndex=25
Nota:
- Isso retornará de 1 a 25 registros.
Para chamar com lastModifiedTime
Nota:
- Se você especificar o tempo, os dados modificados serão pesquisados após o tempo configurado.
Para selecionar todos os campos das oportunidades com newFormat=1
Nota:
- Isso retornará todos os campos que têm valores.
Para selecionar todos os campos das oportunidades com newFormat=2
Nota:
- Isso retornará todos os campos, incluindo campos de valor nulo.
Para chamar com lastModifiedTime, fromIndex e toIndex
Para chamar com lastModifiedTime, fromIndex e toIndex (para o módulo Contas)
Testar programa
Você pode usar o programa anexado para executar e testar o funcionamento do método getRecords em seu ambiente Java.
O programa Java contém o seguinte:
- o formato de geração de tíquete
- os parâmetros e seus valores
- uso real do método
Clique aqui para baixar o programa