Projeto GlobalGiving (Editor Independente) (versão prévia)
A GlobalGiving conecta organizações sem fins lucrativos, doadores e empresas em quase todos os países do mundo. Ajudamos colegas sem fins lucrativos a acessar o financiamento, ferramentas, treinamento e apoio necessários para atender às suas comunidades.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor, Hitachi Solutions |
| Site | https://www.globalgiving.org/ |
| Política de privacidade | https://www.globalgiving.org/aboutus/privacy/ |
| Categorias | Estilo de vida e entretenimento |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | Insira sua Chave de API. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar um cartão-presente |
Essa ação permite que um usuário envie um cartão presente. |
| Enviar uma doação |
Essa ação permite que um usuário envie uma solicitação de doação. |
| Obter contagens de projeto de região para uma região específica |
Essa ação recupera as contagens de projeto para uma região específica. |
| Obter contagens de projetos de região |
Essa ação recupera todas as regiões e países com suas contagens de projetos associadas. |
| Obter designs de cartão-presente |
Ao enviar cartões-presente de email, um design de cartão presente deve ser especificado. Esta ação recupera todos os designs de cartão presente globalgiving disponíveis para selecionar. |
| Obter detalhes do certificado de presente |
Essa ação permite que um usuário consulte a validade e os detalhes de um certificado de presente. |
| Obter faturas pendentes |
Essa ação recupera todas as faturas pendentes ainda não reconciliadas. Essa é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário. |
| Obter galeria de imagens |
Essa ação recupera qualquer imagem extra para um projeto específico. Ao solicitar informações completas <do projeto>, imageGallerySize><indica o número de imagens disponíveis. Se esse número for maior que zero, você poderá acessar as imagens extras usando Esta ação. |
| Obter o máximo de ID de terceiros |
Essa ação recupera a ID máxima (maior em ordem alfabética) de transação de terceiros associada a essa chave de API. Essa é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário. |
| Obter organização |
Essa ação recupera informações para uma organização específica. |
| Obter projetos em destaque |
Essa ação recupera informações para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são girados por hora com base na classificação GlobalGiving e em um algoritmo de "randomização". |
| Obter regiões |
Essa ação recupera todas as regiões. |
| Obter resumo de projetos em destaque |
Essa ação recupera informações resumidas para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são girados por hora com base na classificação GlobalGiving e em um algoritmo de "randomização". |
| Obter resumo de todos os projetos |
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter resumo específico do projeto |
Essa ação exibe um subconjunto das informações completas do projeto para um projeto específico. |
| Obter temas com IDs de projeto |
Essa ação recupera todos os temas do GlobalGiving com suas IDs de projeto associadas. |
|
Obter temas do Global |
Essa ação recupera todos os temas do GlobalGiving. |
| Obter todas as IDs de projetos |
Essa ação recupera todas as IDs de projeto disponíveis. |
| Obter todas as informações de resumo do projeto para o conjunto de IDs do projeto |
Essa ação recupera um subconjunto das informações completas do projeto para projetos filtrados por uma lista de IDs de projeto separadas por vírgulas. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação. |
| Obter todas as informações do projeto para um conjunto de IDs de projeto |
Essa ação recupera informações para projetos filtrados por uma lista de IDs de projeto separadas por vírgulas. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação. |
| Obter todas as organizações |
Essa ação recupera informações para todas as organizações disponíveis. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextOrgId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextOrgId> indica a próxima ID da organização a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos |
Essa ação recupera informações para todos os projetos. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um país ou região |
Essa ação recupera informações para todos os projetos em um país ou região específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um resumo da campanha |
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em uma campanha específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um resumo da organização |
Essa ação recupera as informações completas do projeto para todos os projetos pertencentes a uma organização específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um resumo de país ou região |
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em um país ou região específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um resumo do tema |
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em um tema específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para um tema |
Essa ação recupera informações para todos os projetos em um tema específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para uma campanha |
Essa ação recupera informações para todos os projetos em campanhas específicas. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter todos os projetos para uma organização |
Essa ação recupera as informações completas do projeto para todos os projetos pertencentes a uma organização específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados. |
| Obter token de acesso |
Os tokens de acesso são semelhantes aos tokens de sessão e permitem a inserção de credenciais uma vez por sessão. Depois de autenticado, um usuário recebe um token de acesso que é enviado com cada solicitação segura (aquelas que contêm '/secure/' no caminho da URL, por exemplo, enviando uma doação) em vez de sempre enviar um nome de usuário e senha. Os tokens de acesso são de curta duração e podem expirar, portanto, os usuários precisam obter novamente um token no início de cada sessão ou se o token de acesso atual expirar. Observe que os tempos limite de token de acesso são definidos individualmente para cada usuário de API como uma configuração de banco de dados e, por padrão, são definidos como 10 horas. |
| Obter um projeto específico |
Essa ação exibe informações para um projeto específico. |
| Pesquisar projetos |
Essa ação permite pesquisar projetos usando palavras-chave. |
| Solicitar um certificado de presente |
Essa ação permite que um usuário envie um pedido de um certificado de presente sem enviar detalhes de pagamento. Isso permite à GlobalGiving a capacidade de gerar imediatamente certificados de presente com a compreensão de que a reconciliação do pedido ocorrerá posteriormente. |
Enviar um cartão-presente
Essa ação permite que um usuário envie um cartão presente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
É teste
|
is_test | boolean |
Se a ação é um teste. |
|
|
Código de referência
|
refcode | integer |
O código de referência. |
|
|
ID da transação
|
transactionId | string |
O identificador exclusivo da transação. |
|
|
Email
|
string |
O endereço de email. |
||
|
Quantidade
|
amount | number |
O valor. |
|
|
Primeiro Nome
|
firstname | string |
O nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Linha de endereço 2
|
address2 | string |
A linha de endereço 2. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Código do país
|
iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
|
Código Postal
|
zip | integer |
O cep. |
|
|
Número do Cartão de Crédito
|
creditCardNumber | integer |
Número do cartão de crédito. |
|
|
Código de segurança
|
securityCode | integer |
O código de segurança. |
|
|
Mês da Data de Expiração
|
expiryDateMonth | integer |
O mês de data de expiração. |
|
|
Ano de Data de Expiração
|
expiryDateYear | integer |
A data de validade do ano. |
|
|
ID
|
id | integer |
O identificador exclusivo. |
|
|
Data para enviar
|
dateToSend | string |
A data a ser enviada. |
|
|
Primeiro Nome
|
firstname | string |
O nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Email
|
string |
O endereço de email. |
||
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Recipient
|
to | string |
O destinatário. |
|
|
Remetente
|
from | string |
O remetente. |
|
|
Message
|
message | string |
A mensagem. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Quantidade
|
giftCard.amount | number |
O valor. |
|
Valor cobrado
|
giftCard.chargedAmount | number |
O valor cobrado. |
|
Código de moeda
|
giftCard.currencyCode | string |
O código de moeda. |
|
Date-time
|
giftCard.datetime | string |
A data e hora. |
|
Email
|
giftCard.email | string |
O endereço de email. |
|
Código de referência
|
giftCard.refcode | integer |
O código de referência. |
|
Inscrição do boletim informativo
|
giftCard.signupForCharityNewsletter | boolean |
Se deve se inscrever para o boletim informativo de caridade. |
|
Inscrição no boletim informativo do GG
|
giftCard.signupForGGNewsletter | boolean |
Se deseja se inscrever no boletim informativo do GG. |
|
ID da transação
|
giftCard.transactionId | string |
O identificador exclusivo da transação. |
|
Saída Dada
|
giftCard.checkedOut | boolean |
Se o check-out foi realizado. |
|
Código de moeda
|
giftCard.giftCertificate_detail.currencyCode | string |
O código de moeda. |
|
Número do certificado de presente
|
giftCard.giftCertificate_detail.giftCertificateNumber | string |
O número do certificado do presente. |
|
Valor Restante
|
giftCard.giftCertificate_detail.remainingAmount | number |
O valor restante. |
|
Primeiro Nome
|
giftCard.payment_detail.firstname | string |
O nome. |
|
Apelido
|
giftCard.payment_detail.lastname | string |
O sobrenome. |
|
Endereço
|
giftCard.payment_detail.address | string |
O endereço. |
|
Linha de endereço 2
|
giftCard.payment_detail.address2 | string |
A linha de endereço 2. |
|
City
|
giftCard.payment_detail.city | string |
A cidade. |
|
Estado
|
giftCard.payment_detail.state | string |
O estado. |
|
Código do país
|
giftCard.payment_detail.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Código Postal
|
giftCard.payment_detail.zip | integer |
O cep. |
|
Número do Cartão de Crédito
|
giftCard.payment_detail.creditCardNumber | integer |
O número do cartão de crédito. |
|
Código de segurança
|
giftCard.payment_detail.securityCode | integer |
O código de segurança. |
|
Mês da Data de Expiração
|
giftCard.payment_detail.expiryDateMonth | integer |
O mês de data de expiração. |
|
Ano de Data de Expiração
|
giftCard.payment_detail.expiryDateYear | integer |
A data de validade do ano. |
|
Código de moeda
|
giftCard.receipt.currencyCode | string |
O código de moeda. |
|
Número do recibo
|
giftCard.receipt.receiptNumber | string |
O número do recibo. |
|
Valor dedutível de impostos
|
giftCard.receipt.taxDeductibleContributionAmount | number |
O valor da contribuição dedutível de impostos. |
|
Valor total cobrado
|
giftCard.receipt.totalAmountBilled | number |
O valor total cobrado. |
|
ID
|
giftCard.giftCardDesign.id | integer |
O identificador exclusivo. |
|
Data para enviar
|
giftCard.giftCard_detail.dateToSend | string |
A data a ser enviada. |
|
Primeiro Nome
|
giftCard.giftCard_detail.firstname | string |
O nome. |
|
Apelido
|
giftCard.giftCard_detail.lastname | string |
O sobrenome. |
|
Email
|
giftCard.giftCard_detail.email | string |
O endereço de email. |
|
Telefone
|
giftCard.giftCard_detail.phone | string |
O número de telefone. |
|
Recipient
|
giftCard.giftCard_detail.to | string |
O destinatário. |
|
Remetente
|
giftCard.giftCard_detail.from | string |
O remetente. |
|
Message
|
giftCard.giftCard_detail.message | string |
A mensagem. |
Enviar uma doação
Essa ação permite que um usuário envie uma solicitação de doação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
É teste
|
is_test | boolean |
Se a ação é um teste. |
|
|
Código de referência
|
refcode | integer |
O código de referência. |
|
|
ID da transação
|
transactionId | string |
O identificador exclusivo da transação. |
|
|
Email
|
string |
O endereço de email. |
||
|
Quantidade
|
amount | number |
O valor. |
|
|
ID
|
id | integer |
O identificador exclusivo. |
|
|
Inscrição no boletim informativo do GG
|
signupForGGNewsletter | boolean |
Se deseja se inscrever no boletim informativo do GG. |
|
|
Inscrição do boletim informativo
|
signupForCharityNewsletter | boolean |
Se deve se inscrever para o boletim informativo de caridade. |
|
|
Primeiro Nome
|
firstname | string |
O nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
Linha de endereço 2
|
address2 | string |
A linha de endereço 2. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Código do país
|
iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
|
Gateway de Pagamento
|
paymentGateway | string |
O gateway de pagamento. |
|
|
Chave do Gateway de Pagamento
|
paymentGatewayKey | string |
A chave do gateway de pagamento. |
|
|
Nonce do Gateway de Pagamento
|
paymentGatewayNonce | string |
O nonce do gateway de pagamento. |
|
|
IP do doador
|
ipAddress | string |
O endereço IP do doador. |
|
|
Agente do usuário
|
userAgent | string |
O agente do usuário do doador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Quantidade
|
donation.amount | number |
O valor. |
|
Valor cobrado
|
donation.chargedAmount | number |
O valor cobrado. |
|
Código de moeda
|
donation.currencyCode | string |
O código de moeda. |
|
Date-time
|
donation.datetime | string |
A data e hora. |
|
Email
|
donation.email | string |
O endereço de email. |
|
Financiamento
|
donation.project.funding | number |
O financiamento. |
|
Goal
|
donation.project.goal | integer |
O objetivo. |
|
ID
|
donation.project.id | integer |
O identificador exclusivo. |
|
Número de doações
|
donation.project.numberOfDonations | integer |
O número de doações. |
|
URL do Relatório de Progresso
|
donation.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
donation.project.projectLink | string |
O link do projeto. |
|
Remanescente
|
donation.project.remaining | string |
O restante. |
|
Inscrição do boletim informativo
|
donation.signupForCharityNewsletter | boolean |
Se deve se inscrever para o boletim informativo de caridade. |
|
Inscrição no boletim informativo do GG
|
donation.signupForGGNewsletter | boolean |
Se deseja se inscrever no boletim informativo do GG. |
|
Código de referência
|
donation.refcode | integer |
O código de referência. |
|
ID da transação
|
donation.transactionId | string |
O identificador exclusivo da transação. |
|
Saída Dada
|
donation.checkedOut | boolean |
Se o check-out foi realizado. |
|
Código de moeda
|
donation.giftCertificate_detail.currencyCode | string |
O código de moeda. |
|
Número do certificado de presente
|
donation.giftCertificate_detail.giftCertificateNumber | string |
O número do certificado do presente. |
|
Valor resgatado
|
donation.giftCertificate_detail.redeemedAmount | number |
O valor resgatado. |
|
Valor Restante
|
donation.giftCertificate_detail.remainingAmount | number |
O valor restante. |
|
Número do recibo
|
donation.receipt.receiptNumber | string |
O número do recibo. |
|
Valor dedutível de impostos
|
donation.receipt.taxDeductibleContributionAmount | number |
O valor da contribuição dedutível de impostos. |
|
Valor total cobrado
|
donation.receipt.totalAmountBilled | number |
O valor total cobrado. |
Obter contagens de projeto de região para uma região específica
Essa ação recupera as contagens de projeto para uma região específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
regionname | True | string |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
País
|
regions.region.countries.country | array of object | |
|
Código do país
|
regions.region.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
regions.region.countries.country.name | string |
O nome. |
|
Contagem de projetos
|
regions.region.countries.country.projectCount | integer |
A contagem de projetos. |
|
Nome
|
regions.region.name | string |
O nome. |
Obter contagens de projetos de região
Essa ação recupera todas as regiões e países com suas contagens de projetos associadas.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
País
|
regions.region.countries.country | array of object | |
|
Código do país
|
regions.region.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
regions.region.countries.country.name | string |
O nome. |
|
Contagem de projetos
|
regions.region.countries.country.projectCount | integer |
A contagem de projetos. |
|
Nome
|
regions.region.name | string |
O nome. |
Obter designs de cartão-presente
Ao enviar cartões-presente de email, um design de cartão presente deve ser especificado. Esta ação recupera todos os designs de cartão presente globalgiving disponíveis para selecionar.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
giftCardDesigns.giftCardDesign.active | boolean |
Se ele está ativo. |
|
Endereço necessário
|
giftCardDesigns.giftCardDesign.addressRequired | boolean |
Se o endereço é necessário. |
|
Quantidade necessária
|
giftCardDesigns.giftCardDesign.amountRequired | boolean |
Se o valor é necessário. |
|
Tipo de cartão
|
giftCardDesigns.giftCardDesign.cardType | string |
O tipo de cartão. |
|
Personalizado
|
giftCardDesigns.giftCardDesign.custom | boolean |
Se um design personalizado. |
|
Email necessário
|
giftCardDesigns.giftCardDesign.emailRequired | boolean |
Se o email é necessário. |
|
Certificado de Presente
|
giftCardDesigns.giftCardDesign.giftCertificate | boolean |
Se um certificado de presente. |
|
ID
|
giftCardDesigns.giftCardDesign.id | integer |
O identificador exclusivo. |
|
URL da imagem
|
giftCardDesigns.giftCardDesign.imageUrl | string |
O endereço da URL da imagem. |
|
Mídia
|
giftCardDesigns.giftCardDesign.media | string |
O tipo de mídia. |
|
Nome
|
giftCardDesigns.giftCardDesign.name | string |
O nome. |
|
URL da imagem de visualização
|
giftCardDesigns.giftCardDesign.previewImageUrl | string |
O endereço da URL da imagem de visualização. |
|
Quantidade necessária
|
giftCardDesigns.giftCardDesign.quantityRequired | boolean |
Se a quantidade é necessária. |
|
Enviar para Obrigatório
|
giftCardDesigns.giftCardDesign.sendToRequired | boolean |
Se o envio é necessário. |
|
URL de miniatura
|
giftCardDesigns.giftCardDesign.thumbnailUrl | string |
O endereço da URL em miniatura. |
Obter detalhes do certificado de presente
Essa ação permite que um usuário consulte a validade e os detalhes de um certificado de presente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do certificado do presente
|
giftcertid | True | string |
O identificador exclusivo do presente certicado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de moeda
|
giftCertificate_detail.currencyCode | string |
O código de moeda. |
|
Data de Validade
|
giftCertificate_detail.expirationDate | string |
A data de validade. |
|
Número do certificado de presente
|
giftCertificate_detail.giftCertificateNumber | string |
O número do certificado do presente. |
|
Valor Restante
|
giftCertificate_detail.remainingAmount | number |
Valor restante. |
|
Válido
|
giftCertificate_detail.valid | boolean |
Se é válido. |
Obter faturas pendentes
Essa ação recupera todas as faturas pendentes ainda não reconciliadas. Essa é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Invoice
|
invoices.invoice | array of object | |
|
Quantidade
|
invoices.invoice.amount | number |
O valor. |
|
Data e hora
|
invoices.invoice.datetime | string |
O datetime. |
|
Email
|
invoices.invoice.email | string |
O endereço de email. |
|
ID
|
invoices.invoice.project.id | integer |
O identificador exclusivo. |
|
Número da fatura
|
invoices.invoice.invoiceNumber | string |
O número da fatura. |
Obter galeria de imagens
Essa ação recupera qualquer imagem extra para um projeto específico. Ao solicitar informações completas <do projeto>, imageGallerySize><indica o número de imagens disponíveis. Se esse número for maior que zero, você poderá acessar as imagens extras usando Esta ação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Imagem
|
images.image | array of object | |
|
Title
|
images.image.title | string |
O título. |
|
Link da imagem
|
images.image.imagelink | array of object | |
|
URL
|
images.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
images.image.imagelink._size | string |
O tamanho. |
|
ID
|
images.image._id | integer |
O identificador exclusivo. |
Obter o máximo de ID de terceiros
Essa ação recupera a ID máxima (maior em ordem alfabética) de transação de terceiros associada a essa chave de API. Essa é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de moeda
|
order.currencyCode | string |
O código de moeda. |
|
Inscrição do boletim informativo
|
order.signupForCharityNewsletter | boolean |
Se deve se inscrever para o boletim informativo de caridade. |
|
Inscrição no boletim informativo do GG
|
order.signupForGGNewsletter | boolean |
Se deseja se inscrever no boletim informativo do GG. |
|
ID da transação
|
order.transactionId | string |
O identificador exclusivo da transação. |
Obter organização
Essa ação recupera informações para uma organização específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
organizationid | True | string |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Projeto Ativo
|
organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
organization.addressLine1 | string |
A linha de endereço. |
|
Linha de endereço 2
|
organization.addressLine2 | string |
A linha de endereço 2. |
|
City
|
organization.city | string |
A cidade. |
|
País
|
organization.country | string |
O país. |
|
EIN
|
organization.ein | string |
O número do EIN. |
|
ID
|
organization.id | string |
O identificador exclusivo. |
|
Código do país
|
organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
URL do logótipo
|
organization.logoUrl | string |
O endereço de URL do logotipo. |
|
Missão
|
organization.mission | string |
A missão. |
|
Nome
|
organization.name | string |
O nome. |
|
Código postal
|
organization.postal | string |
O código postal. |
|
Estado
|
organization.state | string |
O estado. |
|
Projeto Total
|
organization.totalProjects | integer |
O número total de projetos. |
|
URL
|
organization.url | string |
O endereço da URL. |
|
Tema
|
organization.themes.theme | array of object | |
|
ID
|
organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
organization.themes.theme.name | string |
O nome. |
|
País
|
organization.countries.country | array of object | |
|
Código do país
|
organization.countries.country.iso3166CountryCode | string |
O código do país ISO3166. |
|
Nome
|
organization.countries.country.name | string |
O nome. |
Obter projetos em destaque
Essa ação recupera informações para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são girados por hora com base na classificação GlobalGiving e em um algoritmo de "randomização".
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter regiões
Essa ação recupera todas as regiões.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Região
|
regions.region | array of object | |
|
Nome
|
regions.region.name | string |
O nome. |
Obter resumo de projetos em destaque
Essa ação recupera informações resumidas para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são girados por hora com base na classificação GlobalGiving e em um algoritmo de "randomização".
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter resumo de todos os projetos
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
País
|
projects.project.country | string |
O país. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter resumo específico do projeto
Essa ação exibe um subconjunto das informações completas do projeto para um projeto específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
project.active | boolean |
Se está ativo. |
|
País
|
project.country | string |
O país. |
|
Código do país
|
project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
project.countries.country.name | string |
O nome. |
|
Opção de doação
|
project.donationOptions.donationOption | array of object | |
|
Quantidade
|
project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
project.imageLink | string |
O link da imagem. |
|
Código do país
|
project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Linha de Endereço
|
project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
project.organization.city | string |
A cidade. |
|
País
|
project.organization.country | string |
O país. |
|
ID
|
project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
project.organization.name | string |
O nome. |
|
Código postal
|
project.organization.postal | string |
O código postal. |
|
URL
|
project.organization.url | string |
O endereço da URL. |
|
Tema
|
project.organization.themes.theme | array of object | |
|
ID
|
project.organization.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
project.organization.themes.theme.name | string |
O nome. |
|
País
|
project.organization.countries.country | array of object | |
|
Código do país
|
project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
project.organization.countries.country.name | string |
O nome. |
|
Situação
|
project.status | string |
O status. |
|
Resumo
|
project.summary | string |
O resumo. |
|
Tema
|
project.themes.theme | array of object | |
|
ID
|
project.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
project.themes.theme.name | string |
O nome. |
|
Nome do tema
|
project.themeName | string |
O nome do tema. |
|
Title
|
project.title | string |
O título. |
|
Tipo
|
project.type | string |
O tipo. |
Obter temas com IDs de projeto
Essa ação recupera todos os temas do GlobalGiving com suas IDs de projeto associadas.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tema
|
themes.theme | array of object | |
|
ID
|
themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
themes.theme.name | string |
O nome. |
|
projeto
|
themes.theme.projects.project | array of object |
Projeto. |
|
ID
|
themes.theme.projects.project.id | integer |
O identificador exclusivo. |
|
Número encontrado
|
themes.theme.projects._numberFound | integer |
O número encontrado. |
|
Texto
|
themes.theme.projects.__text | string |
O texto |
Obter temas do GlobalGiving
Essa ação recupera todos os temas do GlobalGiving.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tema
|
themes.theme | array of object | |
|
ID
|
themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
themes.theme.name | string |
O nome. |
Obter todas as IDs de projetos
Essa ação recupera todas as IDs de projeto disponíveis.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Projeto
|
projects.project | array of object | |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todas as informações de resumo do projeto para o conjunto de IDs do projeto
Essa ação recupera um subconjunto das informações completas do projeto para projetos filtrados por uma lista de IDs de projeto separadas por vírgulas. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs do projeto
|
projectIds | string |
Os identificadores exclusivos do projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
Obter todas as informações do projeto para um conjunto de IDs de projeto
Essa ação recupera informações para projetos filtrados por uma lista de IDs de projeto separadas por vírgulas. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs do projeto
|
projectIds | string |
Os identificadores exclusivos do projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Projeto
|
projects.project | array of object | |
|
Active
|
projects.project.active | boolean |
Se o projeto está ativo. |
|
País
|
projects.project.countries.country | array of object | |
|
código do país ISO3166
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
País
|
projects.project.country | array of string |
O país(ies). |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.description | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link para a imagem. |
|
código do país ISO3166
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | array of string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
CEP
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Nome do tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todas as organizações
Essa ação recupera informações para todas as organizações disponíveis. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextOrgId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextOrgId> indica a próxima ID da organização a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Próxima ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
organizations.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID da Organização
|
organizations.nextOrgId | integer |
O identificador exclusivo da próxima organização. |
|
organização
|
organizations.organization | array of |
Obter todos os projetos
Essa ação recupera informações para todos os projetos. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um país ou região
Essa ação recupera informações para todos os projetos em um país ou região específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
iso3166CountryCode | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo da campanha
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em uma campanha específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaignId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
País
|
projects.project.country | string |
O país. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo da organização
Essa ação recupera as informações completas do projeto para todos os projetos pertencentes a uma organização específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
OrganizationId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo de país ou região
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em um país ou região específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
iso3166CountryCode | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
País
|
projects.project.country | string |
O país. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo do tema
Essa ação recupera um subconjunto das informações completas do projeto para todos os projetos em um tema específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
themeId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
País
|
projects.project.country | string |
O país. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Estado
|
projects.project.organization.state | string |
O estado. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um tema
Essa ação recupera informações para todos os projetos em um tema específico. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
themeId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para uma campanha
Essa ação recupera informações para todos os projetos em campanhas específicas. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaignId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | string |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para uma organização
Essa ação recupera as informações completas do projeto para todos os projetos pertencentes a uma organização específica. O conjunto de resultados, no entanto, é limitado a um máximo de 10 resultados para cada solicitação. Se houver mais resultados disponíveis, a resposta retornará dois elementos <extras hasNext> e <nextProjectId>. Observe que esses dois elementos não estarão presentes se não houver mais resultados disponíveis. O <elemento hasNext> indica se há mais resultados disponíveis e o <elemento nextProjectId> indica a próxima ID do projeto a ser incluída na cadeia de caracteres de consulta para recuperar o próximo conjunto de resultados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
OrganizationId | True | string |
O identificador exclusivo da campanha. |
|
Próxima ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Avançar
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próxima ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se ele está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
projects.project.contactAddress2 | string |
O endereço do contato linha 2. |
|
Cidade do Contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
projects.project.contactCountry | string |
O país do contato. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
projects.project.contactPostal | string |
O postal do contato. |
|
Estado de contato
|
projects.project.contactState | string |
O estado do contato. |
|
Título do Contato
|
projects.project.contactTitle | string |
O título do contato. |
|
URL de contato
|
projects.project.contactUrl | string |
A URL do contato. |
|
País
|
projects.project.country | string |
O país. |
|
Código do país
|
projects.project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.countries.country.name | string |
O nome. |
|
Data do relatório
|
projects.project.dateOfMostRecentReport | string |
A data do relatório mais recente. |
|
Opção de doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Goal
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria
|
projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem
|
projects.project.image.imagelink | array of object | |
|
URL
|
projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
projects.project.image.title | string |
O título. |
|
ID
|
projects.project.image._id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Data modificada
|
projects.project.modifiedDate | string |
A data modificada. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Informativo
|
projects.project.notice | string |
O aviso. |
|
Número de doações
|
projects.project.numberOfDonations | integer |
O número de doações. |
|
Número de relatórios
|
projects.project.numberOfReports | string |
O número de relatórios. |
|
Projetos Ativos
|
projects.project.organization.activeProjects | string |
Os projetos ativos. |
|
Linha de Endereço
|
projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
projects.project.organization.city | string |
A cidade. |
|
País
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Missão
|
projects.project.organization.mission | string |
A missão. |
|
Nome
|
projects.project.organization.name | string |
O nome. |
|
Código postal
|
projects.project.organization.postal | string |
O código postal. |
|
Total de projetos
|
projects.project.organization.totalProjects | string |
O total de projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço da URL. |
|
Tema
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
País
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
URL do Relatório de Progresso
|
projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
URL do Projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Remanescente
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O resumo. |
|
Tema
|
projects.project.themeName | string |
O nome do tema. |
|
Tema
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identifer exclusivo. |
|
Nome
|
projects.project.themes.theme.name | string |
O nome. |
|
Title
|
projects.project.title | string |
O título. |
|
Tipo
|
projects.project.type | string |
O tipo. |
|
URL
|
projects.project.videos.video.url | string |
O endereço da URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter token de acesso
Os tokens de acesso são semelhantes aos tokens de sessão e permitem a inserção de credenciais uma vez por sessão. Depois de autenticado, um usuário recebe um token de acesso que é enviado com cada solicitação segura (aquelas que contêm '/secure/' no caminho da URL, por exemplo, enviando uma doação) em vez de sempre enviar um nome de usuário e senha. Os tokens de acesso são de curta duração e podem expirar, portanto, os usuários precisam obter novamente um token no início de cada sessão ou se o token de acesso atual expirar. Observe que os tempos limite de token de acesso são definidos individualmente para cada usuário de API como uma configuração de banco de dados e, por padrão, são definidos como 10 horas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de email da conta. |
||
|
Senha
|
password | string |
A senha da conta. |
|
|
Chave de API
|
api_key | string |
A chave da API da conta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Token de acesso
|
auth_response.access_token | string |
O token de acesso. |
Obter um projeto específico
Essa ação exibe informações para um projeto específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador exclusivo da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
project.active | boolean |
Se está ativo. |
|
Activities
|
project.activities | string |
As atividades. |
|
Documentação adicional
|
project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
project.contactAddress | string |
O endereço do contato. |
|
Cidade do Contato
|
project.contactCity | string |
A cidade do contato. |
|
País de contato
|
project.contactCountry | string |
O país do contato. |
|
Contato
|
project.contactName | string |
O nome do contato. |
|
Contate o Postal
|
project.contactPostal | integer |
O postal do contato. |
|
Estado de contato
|
project.contactState | string |
O estado do contato. |
|
Título do Contato
|
project.contactTitle | string |
O título do contato. |
|
URL de contato
|
project.contactUrl | string |
O endereço de URL do contato. |
|
Código do país
|
project.countries.country.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Nome
|
project.countries.country.name | string |
O nome. |
|
País
|
project.country | string |
O país. |
|
Código do país
|
project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Opção de doação
|
project.donationOptions.donationOption | array of object | |
|
Quantidade
|
project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
project.funding | number |
O financiamento. |
|
Goal
|
project.goal | integer |
O objetivo. |
|
ID
|
project.id | string |
O identificador exclusivo. |
|
Tamanho da Galeria de Imagens
|
project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
project.imageLink | string |
O link da imagem. |
|
Imagem
|
project.imageSizeOptions.image | array of object | |
|
URL
|
project.imageSizeOptions.image.url | string |
O endereço da URL. |
|
Tamanho
|
project.imageSizeOptions.image._size | string |
O tamanho. |
|
Latitude
|
project.latitude | string |
A latitude. |
|
Impacto a longo prazo
|
project.longTermImpact | string |
O impacto a longo prazo. |
|
Longitude
|
project.longitude | string |
A longitude. |
|
Necessidade
|
project.need | string |
A necessidade. |
|
Informativo
|
project.notice | string |
O aviso. |
|
Número de doações
|
project.numberOfDonations | integer |
O número de doações. |
|
Linha de Endereço
|
project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
project.organization.city | string |
A cidade. |
|
País
|
project.organization.country | string |
O país. |
|
ID
|
project.organization.id | integer |
O identificador exclusivo. |
|
Código do país
|
project.organization.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
URL do logótipo
|
project.organization.logoUrl | string |
O endereço de URL do logotipo. |
|
Nome
|
project.organization.name | string |
O nome. |
|
Código postal
|
project.organization.postal | string |
O código postal. |
|
URL
|
project.organization.url | string |
O endereço da URL. |
|
Link do Relatório de Progresso
|
project.progressReportLink | string |
O link do relatório de progresso. |
|
Link do Projeto
|
project.projectLink | string |
O link do projeto. |
|
Remanescente
|
project.remaining | string |
O restante. |
|
Situação
|
project.status | string |
O status. |
|
Resumo
|
project.summary | string |
O resumo. |
|
Nome do tema
|
project.themeName | string |
O nome do tema. |
|
Tema
|
project.themes.theme | array of object | |
|
ID
|
project.themes.theme.id | integer |
O identificador exclusivo. |
|
Nome
|
project.themes.theme.name | string |
O nome. |
|
Title
|
project.title | string |
O título. |
Pesquisar projetos
Essa ação permite pesquisar projetos usando palavras-chave.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Query
|
q | string |
A cadeia de caracteres de consulta. |
|
|
Start
|
start | integer |
O número inicial. |
|
|
Filter
|
filter | string |
A cadeia de caracteres de filtro. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
search.request.filters.filter.name | string |
O nome. |
|
Value
|
search.request.filters.filter.value | string |
O valor. |
|
Query
|
search.request.q | string |
A cadeia de caracteres de consulta. |
|
Start
|
search.request.start | integer |
O início. |
|
Resumo
|
search.request.summary | string |
O resumo. |
|
Active
|
search.response.projects.project.active | boolean |
Se está ativo. |
|
Activities
|
search.response.projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
search.response.projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data aprovada
|
search.response.projects.project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
search.response.projects.project.contactAddress | string |
O endereço do contato. |
|
Endereço de contato 2
|
search.response.projects.project.contactAddress2 | string |
O endereço do contato2. |
|
Cidade do Contato
|
search.response.projects.project.contactCity | string |
A cidade do contato. |
|
País de contato
|
search.response.projects.project.contactCountry | string |
O país do contato. |
|
Email de contato
|
search.response.projects.project.contactEmail | string |
O email do contato. |
|
Contato
|
search.response.projects.project.contactName | string |
O nome do contato. |
|
Telefone de contato
|
search.response.projects.project.contactPhone | string |
O telefone do contato. |
|
Contate o Postal
|
search.response.projects.project.contactPostal | integer |
O postal do contato. |
|
Estado de contato
|
search.response.projects.project.contactState | string |
O estado do contato. |
|
URL de contato
|
search.response.projects.project.contactUrl | string |
O endereço de URL do contato. |
|
País
|
search.response.projects.project.country | string |
O país. |
|
Opção de doação.
|
search.response.projects.project.donationOptions.donationOption | array of object | |
|
Quantidade
|
search.response.projects.project.donationOptions.donationOption.amount | number |
O valor. |
|
Description
|
search.response.projects.project.donationOptions.donationOption.description | string |
A descrição. |
|
Financiamento
|
search.response.projects.project.funding | number |
O financiamento. |
|
Goal
|
search.response.projects.project.goal | integer |
O objetivo. |
|
ID
|
search.response.projects.project.id | integer |
O identificador exclusivo. |
|
Tamanho da Galeria de Imagens
|
search.response.projects.project.imageGallerySize | string |
O tamanho da galeria de imagens. |
|
Link da imagem
|
search.response.projects.project.imageLink | string |
O link da imagem. |
|
Link da imagem.
|
search.response.projects.project.image.imagelink | array of object | |
|
URL
|
search.response.projects.project.image.imagelink.url | string |
O endereço da URL. |
|
Tamanho
|
search.response.projects.project.image.imagelink._size | string |
O tamanho |
|
Title
|
search.response.projects.project.image.title | string |
O título. |
|
ID
|
search.response.projects.project.image._id | string |
O identificador exclusivo. |
|
Código do país
|
search.response.projects.project.iso3166CountryCode | string |
O código do país no formato ISO3166. |
|
Impacto a longo prazo
|
search.response.projects.project.longTermImpact | string |
O impacto a longo prazo. |
|
Necessidade
|
search.response.projects.project.need | string |
A necessidade. |
|
Número de doações
|
search.response.projects.project.numberOfDonations | integer |
O número de doações. |
|
Linha de Endereço
|
search.response.projects.project.organization.addressLine1 | string |
A linha de endereço. |
|
City
|
search.response.projects.project.organization.city | string |
A cidade. |
|
País
|
search.response.projects.project.organization.country | string |
O país. |
|
ID
|
search.response.projects.project.organization.id | string |
O identificador exclusivo. |
|
Nome
|
search.response.projects.project.organization.name | string |
O nome. |
|
Código postal
|
search.response.projects.project.organization.postal | string |
O código postal. |
|
Link do Relatório de Progresso
|
search.response.projects.project.progressReportLink | string |
O link do relatório de progresso. |
|
Link do Projeto
|
search.response.projects.project.projectLink | string |
O link do projeto. |
|
Região
|
search.response.projects.project.region | string |
A região. |
|
Remanescente
|
search.response.projects.project.remaining | string |
O restante. |
|
Situação
|
search.response.projects.project.status | string |
O status. |
|
Resumo
|
search.response.projects.project.summary | string |
O resumo. |
|
Nome do tema
|
search.response.projects.project.themeName | string |
O nome do tema. |
|
Title
|
search.response.projects.project.title | string |
O título. |
|
Start
|
search.response._start | integer |
O início. |
|
Número encontrado
|
search.response._numberFound | integer |
O número encontrado. |
Solicitar um certificado de presente
Essa ação permite que um usuário envie um pedido de um certificado de presente sem enviar detalhes de pagamento. Isso permite à GlobalGiving a capacidade de gerar imediatamente certificados de presente com a compreensão de que a reconciliação do pedido ocorrerá posteriormente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
É teste
|
is_test | boolean |
Se a ação é um teste. |
|
|
Código de referência
|
refcode | integer |
O código de referência. |
|
|
Quantidade
|
amount | number |
O valor. |
|
|
ID de terceiros
|
thirdPartyIdentifier | string |
O identificador de terceiros. |
|
|
Código de moeda
|
currencyCode | string |
O código de moeda. |
|
|
Data de Validade
|
expirationDate | string |
A data de validade. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número do certificado de presente
|
giftCertificate_detail.giftCertificateNumber | string |
O número do certificado do presente. |
|
Valor Restante
|
giftCertificate_detail.remainingAmount | number |
Valor restante. |
|
ID de terceiros
|
giftCertificate_detail.thirdPartyIdentifier | string |
O identificador de terceiros. |
|
Código de moeda
|
giftCertificate_detail.currencyCode | string |
O código de moeda. |
|
Resgatar URL
|
giftCertificate_detail.redeemUrl | string |
O endereço de URL de resgate. |
|
Data de Validade
|
giftCertificate_detail.expirationDate | string |
A data de validade. |