GlobalGiving Project (Editora Independente) (Pré-visualização)
A GlobalGiving conecta organizações sem fins lucrativos, doadores e empresas em quase todos os países do mundo. Ajudamos outras organizações sem fins lucrativos a aceder ao financiamento, ferramentas, formação e apoio de que necessitam para servir as suas comunidades.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troy Taylor, Soluções Hitachi |
| Sítio Web | https://www.globalgiving.org/ |
| Política de privacidade | https://www.globalgiving.org/aboutus/privacy/ |
| Categorias | Estilo de vida e entretenimento |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 | Introduza a sua chave API. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Encomende um vale-presente |
Essa ação permite que um usuário envie um pedido de vale-presente sem enviar detalhes de pagamento. Isso permite à GlobalGiving a capacidade de gerar imediatamente vales-presente com o entendimento de que a reconciliação do pedido ocorrerá em uma data posterior. |
| Enviar um cartão-presente |
Esta ação permite que um usuário envie um cartão-presente. |
| Enviar um donativo |
Esta ação permite que um usuário envie uma solicitação de doação. |
| Obtenha designs de cartões-presente |
Ao enviar cartões-presente por e-mail, um design de cartão de presente deve ser especificado. Esta ação recupera todos os designs de vale-presente GlobalGiving disponíveis para selecionar. |
| Obtenha o máximo de ID de terceiros |
Esta ação recupera o id máximo (maior em ordem alfabética) de transação de terceiros associado a essa chave de API. Esta é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário. |
| Obtenha organização |
Esta ação recupera informações de uma organização específica. |
| Obtenha todas as organizações |
Esta 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 estã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 contagens de projetos de região |
Esta ação recupera todas as regiões e países com as contagens de projetos associados. |
| Obter contagens de projetos de região para uma região específica |
Esta ação recupera contagens de projetos para uma região específica. |
| Obter detalhes do vale-presente |
Essa ação permite que um usuário consulte a validade e os detalhes de um vale-presente. |
| Obter faturas pendentes |
Esta ação recupera todas as faturas pendentes ainda não reconciliadas. Esta é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário. |
| Obter galeria de imagens |
Esta ação recupera quaisquer imagens extras para um projeto específico. Ao solicitar informações completas <do projeto> , o <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 projeto específico |
Esta ação exibe informações para um projeto específico. |
| Obter projetos em destaque |
Esta ação recupera informações para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são rodados por hora com base no ranking GlobalGiving e em um algoritmo de "randomização". |
| Obter regiões |
Esta ação recupera todas as regiões. |
| Obter resumo de todos os projetos |
Esta 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 estã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 de todos os projetos para um país ou região |
Esta 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 estã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 dos projetos em destaque |
Esta ação recupera informações resumidas para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são rodados por hora com base no ranking GlobalGiving e em um algoritmo de "randomização". |
| Obter resumo específico do projeto |
Esta ação exibe um subconjunto das informações completas do projeto para um projeto específico. |
| Obter temas com IDs de projeto |
Esta ação recupera todos os temas GlobalGiving com seus IDs de projeto associados. |
|
Obter temas Global |
Esta ação recupera todos os temas do GlobalGiving . |
| Obter todas as informações de resumo do projeto para o conjunto de IDs do projeto |
Esta ação recupera um subconjunto das informações completas do projeto para projetos filtrados por uma lista de ids de projeto separadas por vírgula. 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 |
Esta ação recupera informações para projetos filtrados por uma lista de ids de projeto separadas por vírgula. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação. |
| Obter todos os IDs de projetos |
Esta ação recupera todas as IDs de projeto disponíveis. |
| Obter todos os projetos |
Esta ação recupera informações de 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 estã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 |
Esta ação recupera informações sobre todos os projetos num país ou região específicos. 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 estã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 |
Esta ação recupera um subconjunto das informações completas do projeto para todos os projetos de 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 estã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 |
Esta 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 estã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 |
Esta 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 estã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 |
Esta ação recupera informações para todos os projetos de 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 estã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 |
Esta ação recupera informações sobre todos os projetos da 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 estã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 |
Esta 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 estã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. Uma vez 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 do token de acesso são definidos individualmente para cada usuário da API como uma configuração de banco de dados e, por padrão, são definidos como 10 horas. |
| Pesquisar projetos |
Esta ação permite pesquisar projetos utilizando palavras-chave. |
Encomende um vale-presente
Essa ação permite que um usuário envie um pedido de vale-presente sem enviar detalhes de pagamento. Isso permite à GlobalGiving a capacidade de gerar imediatamente vales-presente com o entendimento de que a reconciliação do pedido ocorrerá em uma data posterior.
Parâmetros
| Name | Chave | Necessá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. |
|
|
Montante
|
amount | number |
O montante. |
|
|
ID de terceiros
|
thirdPartyIdentifier | string |
O identificador de terceiros. |
|
|
Código de Moeda
|
currencyCode | string |
O código da moeda. |
|
|
Data de validade
|
expirationDate | string |
A data de validade. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número do vale-presente
|
giftCertificate_detail.giftCertificateNumber | string |
O número do vale-presente. |
|
Montante Restante
|
giftCertificate_detail.remainingAmount | number |
Montante restante. |
|
ID de terceiros
|
giftCertificate_detail.thirdPartyIdentifier | string |
O identificador de terceiros. |
|
Código de Moeda
|
giftCertificate_detail.currencyCode | string |
O código da moeda. |
|
Resgatar URL
|
giftCertificate_detail.redeemUrl | string |
O endereço URL de resgate. |
|
Data de validade
|
giftCertificate_detail.expirationDate | string |
A data de validade. |
Enviar um cartão-presente
Esta ação permite que um usuário envie um cartão-presente.
Parâmetros
| Name | Chave | Necessá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 e-mail. |
||
|
Montante
|
amount | number |
O montante. |
|
|
Nome Próprio
|
firstname | string |
O primeiro nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Address
|
address | string |
O endereço. |
|
|
Endereço Linha 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 código postal. |
|
|
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. |
|
|
Data de validade: Mês
|
expiryDateMonth | integer |
A data de validade do mês. |
|
|
Data de validade Ano
|
expiryDateYear | integer |
O ano de validade. |
|
|
ID
|
id | integer |
O identificador único. |
|
|
Data de envio
|
dateToSend | string |
A data a enviar. |
|
|
Nome Próprio
|
firstname | string |
O primeiro nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Email
|
string |
O endereço de e-mail. |
||
|
Telemóvel
|
phone | string |
O número de telefone. |
|
|
Recipient
|
to | string |
O destinatário. |
|
|
Remetente
|
from | string |
O remetente. |
|
|
Message
|
message | string |
A mensagem. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Montante
|
giftCard.amount | number |
O montante. |
|
Valor cobrado
|
giftCard.chargedAmount | number |
O valor cobrado. |
|
Código de Moeda
|
giftCard.currencyCode | string |
O código da moeda. |
|
Date-time
|
giftCard.datetime | string |
A data-hora. |
|
Email
|
giftCard.email | string |
O endereço de e-mail. |
|
Código de Referência
|
giftCard.refcode | integer |
O código de referência. |
|
Inscrição na Newsletter
|
giftCard.signupForCharityNewsletter | boolean |
Se você deve se inscrever para o boletim informativo de caridade. |
|
Inscrição na Newsletter GG
|
giftCard.signupForGGNewsletter | boolean |
Se você deve se inscrever para a newsletter GG. |
|
ID da transação
|
giftCard.transactionId | string |
O identificador exclusivo da transação. |
|
Check-out
|
giftCard.checkedOut | boolean |
Se fez check-out. |
|
Código de Moeda
|
giftCard.giftCertificate_detail.currencyCode | string |
O código da moeda. |
|
Número do vale-presente
|
giftCard.giftCertificate_detail.giftCertificateNumber | string |
O número do vale-presente. |
|
Montante Restante
|
giftCard.giftCertificate_detail.remainingAmount | number |
O montante restante. |
|
Nome Próprio
|
giftCard.payment_detail.firstname | string |
O primeiro nome. |
|
Apelido
|
giftCard.payment_detail.lastname | string |
O sobrenome. |
|
Address
|
giftCard.payment_detail.address | string |
O endereço. |
|
Endereço Linha 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 código postal. |
|
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. |
|
Data de validade: Mês
|
giftCard.payment_detail.expiryDateMonth | integer |
A data de validade do mês. |
|
Data de validade Ano
|
giftCard.payment_detail.expiryDateYear | integer |
O ano de validade. |
|
Código de Moeda
|
giftCard.receipt.currencyCode | string |
O código da moeda. |
|
Número do recibo
|
giftCard.receipt.receiptNumber | string |
O número do recibo. |
|
Valor Dedutível do Imposto
|
giftCard.receipt.taxDeductibleContributionAmount | number |
O valor da contribuição dedutível do imposto. |
|
Valor total faturado
|
giftCard.receipt.totalAmountBilled | number |
O valor total faturado. |
|
ID
|
giftCard.giftCardDesign.id | integer |
O identificador único. |
|
Data de envio
|
giftCard.giftCard_detail.dateToSend | string |
A data a enviar. |
|
Nome Próprio
|
giftCard.giftCard_detail.firstname | string |
O primeiro nome. |
|
Apelido
|
giftCard.giftCard_detail.lastname | string |
O sobrenome. |
|
Email
|
giftCard.giftCard_detail.email | string |
O endereço de e-mail. |
|
Telemóvel
|
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 um donativo
Esta ação permite que um usuário envie uma solicitação de doação.
Parâmetros
| Name | Chave | Necessá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 e-mail. |
||
|
Montante
|
amount | number |
O montante. |
|
|
ID
|
id | integer |
O identificador único. |
|
|
Inscrição na Newsletter GG
|
signupForGGNewsletter | boolean |
Se você deve se inscrever para a newsletter GG. |
|
|
Inscrição na Newsletter
|
signupForCharityNewsletter | boolean |
Se você deve se inscrever para o boletim informativo de caridade. |
|
|
Nome Próprio
|
firstname | string |
O primeiro nome. |
|
|
Apelido
|
lastname | string |
O sobrenome. |
|
|
Address
|
address | string |
O endereço. |
|
|
Endereço Linha 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. |
|
|
Gateway de Pagamento Nonce
|
paymentGatewayNonce | string |
O gateway de pagamento nonce. |
|
|
IP do doador
|
ipAddress | string |
Endereço IP do doador. |
|
|
Agente de usuário
|
userAgent | string |
O agente de utilizador do dador. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Montante
|
donation.amount | number |
O montante. |
|
Valor cobrado
|
donation.chargedAmount | number |
O valor cobrado. |
|
Código de Moeda
|
donation.currencyCode | string |
O código da moeda. |
|
Date-time
|
donation.datetime | string |
A data-hora. |
|
Email
|
donation.email | string |
O endereço de e-mail. |
|
Financiamento
|
donation.project.funding | number |
O financiamento. |
|
Objetivo
|
donation.project.goal | integer |
O objetivo. |
|
ID
|
donation.project.id | integer |
O identificador único. |
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
donation.project.projectLink | string |
O link do projeto. |
|
Restantes
|
donation.project.remaining | string |
O restante. |
|
Inscrição na Newsletter
|
donation.signupForCharityNewsletter | boolean |
Se você deve se inscrever para o boletim informativo de caridade. |
|
Inscrição na Newsletter GG
|
donation.signupForGGNewsletter | boolean |
Se você deve se inscrever para a newsletter 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. |
|
Check-out
|
donation.checkedOut | boolean |
Se fez check-out. |
|
Código de Moeda
|
donation.giftCertificate_detail.currencyCode | string |
O código da moeda. |
|
Número do vale-presente
|
donation.giftCertificate_detail.giftCertificateNumber | string |
O número do vale-presente. |
|
Valor resgatado
|
donation.giftCertificate_detail.redeemedAmount | number |
O montante resgatado. |
|
Montante Restante
|
donation.giftCertificate_detail.remainingAmount | number |
O montante restante. |
|
Número do recibo
|
donation.receipt.receiptNumber | string |
O número do recibo. |
|
Valor Dedutível do Imposto
|
donation.receipt.taxDeductibleContributionAmount | number |
O valor da contribuição dedutível do imposto. |
|
Valor total faturado
|
donation.receipt.totalAmountBilled | number |
O valor total faturado. |
Obtenha designs de cartões-presente
Ao enviar cartões-presente por e-mail, um design de cartão de presente deve ser especificado. Esta ação recupera todos os designs de vale-presente GlobalGiving disponíveis para selecionar.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
giftCardDesigns.giftCardDesign.active | boolean |
Se está ativo. |
|
Endereço Obrigatório
|
giftCardDesigns.giftCardDesign.addressRequired | boolean |
Se o endereço é obrigatório. |
|
Quantidade necessária
|
giftCardDesigns.giftCardDesign.amountRequired | boolean |
Se a quantidade é necessária. |
|
Tipo de Cartão
|
giftCardDesigns.giftCardDesign.cardType | string |
O tipo de cartão. |
|
Personalizado
|
giftCardDesigns.giftCardDesign.custom | boolean |
Seja um design personalizado. |
|
E-mail necessário
|
giftCardDesigns.giftCardDesign.emailRequired | boolean |
Se o e-mail é necessário. |
|
Vale de Presente
|
giftCardDesigns.giftCardDesign.giftCertificate | boolean |
Seja um vale-presente. |
|
ID
|
giftCardDesigns.giftCardDesign.id | integer |
O identificador único. |
|
URL da imagem
|
giftCardDesigns.giftCardDesign.imageUrl | string |
O endereço 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 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 para é necessário. |
|
URL da miniatura
|
giftCardDesigns.giftCardDesign.thumbnailUrl | string |
O endereço URL da miniatura. |
Obtenha o máximo de ID de terceiros
Esta ação recupera o id máximo (maior em ordem alfabética) de transação de terceiros associado a essa chave de API. Esta é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Moeda
|
order.currencyCode | string |
O código da moeda. |
|
Inscrição na Newsletter
|
order.signupForCharityNewsletter | boolean |
Se você deve se inscrever para o boletim informativo de caridade. |
|
Inscrição na Newsletter GG
|
order.signupForGGNewsletter | boolean |
Se você deve se inscrever para a newsletter GG. |
|
ID da transação
|
order.transactionId | string |
O identificador exclusivo da transação. |
Obtenha organização
Esta ação recupera informações de uma organização específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
organizationid | True | string |
O identificador único da campanha. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Projeto Ativo
|
organization.activeProjects | string |
Os projetos ativos. |
|
Linha de endereço
|
organization.addressLine1 | string |
A linha de endereço. |
|
Endereço Linha 2
|
organization.addressLine2 | string |
A linha de endereço 2. |
|
City
|
organization.city | string |
A cidade. |
|
Country
|
organization.country | string |
O país. |
|
EIN
|
organization.ein | string |
O número EIN. |
|
ID
|
organization.id | string |
O identificador único. |
|
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 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. |
|
Total do Projeto
|
organization.totalProjects | integer |
O número total de projetos. |
|
URL
|
organization.url | string |
O endereço URL. |
|
Theme
|
organization.themes.theme | array of object | |
|
ID
|
organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
organization.themes.theme.name | string |
O nome. |
|
Country
|
organization.countries.country | array of object | |
|
Código do país
|
organization.countries.country.iso3166CountryCode | string |
O ISO3166 código do país. |
|
Nome
|
organization.countries.country.name | string |
O nome. |
Obtenha todas as organizações
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Próximo ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
organizations.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID da organização
|
organizations.nextOrgId | integer |
O identificador exclusivo da próxima organização. |
|
organização
|
organizations.organization | array of |
Obter contagens de projetos de região
Esta ação recupera todas as regiões e países com as contagens de projetos associados.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Country
|
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 |
O projeto conta. |
|
Nome
|
regions.region.name | string |
O nome. |
Obter contagens de projetos de região para uma região específica
Esta ação recupera contagens de projetos para uma região específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
regionname | True | string |
O identificador único da campanha. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Country
|
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 |
O projeto conta. |
|
Nome
|
regions.region.name | string |
O nome. |
Obter detalhes do vale-presente
Essa ação permite que um usuário consulte a validade e os detalhes de um vale-presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do vale-presente
|
giftcertid | True | string |
O identificador único do certificado de oferta. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Moeda
|
giftCertificate_detail.currencyCode | string |
O código da moeda. |
|
Data de validade
|
giftCertificate_detail.expirationDate | string |
A data de validade. |
|
Número do vale-presente
|
giftCertificate_detail.giftCertificateNumber | string |
O número do vale-presente. |
|
Montante Restante
|
giftCertificate_detail.remainingAmount | number |
Montante restante. |
|
Válido
|
giftCertificate_detail.valid | boolean |
Se é válido. |
Obter faturas pendentes
Esta ação recupera todas as faturas pendentes ainda não reconciliadas. Esta é uma solicitação segura, portanto, um token de acesso (autenticação) é necessário.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Invoice
|
invoices.invoice | array of object | |
|
Montante
|
invoices.invoice.amount | number |
O montante. |
|
Data e hora
|
invoices.invoice.datetime | string |
A data/hora. |
|
Email
|
invoices.invoice.email | string |
O endereço de e-mail. |
|
ID
|
invoices.invoice.project.id | integer |
O identificador único. |
|
Número da Fatura
|
invoices.invoice.invoiceNumber | string |
O número da fatura. |
Obter galeria de imagens
Esta ação recupera quaisquer imagens extras para um projeto específico. Ao solicitar informações completas <do projeto> , o <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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador único da campanha. |
Devoluções
| Name | 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 URL. |
|
Tamanho
|
images.image.imagelink._size | string |
O tamanho. |
|
ID
|
images.image._id | integer |
O identificador único. |
Obter projeto específico
Esta ação exibe informações para um projeto específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador único da campanha. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
project.active | boolean |
Se ativo. |
|
Activities
|
project.activities | string |
As atividades. |
|
Documentação adicional
|
project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
project.approvedDate | string |
A data aprovada. |
|
Endereço de contato
|
project.contactAddress | string |
O endereço do contato. |
|
Cidade de contato
|
project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
project.contactCountry | string |
O país do contacto. |
|
Contato
|
project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
project.contactPostal | integer |
O contato é postal. |
|
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 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. |
|
Country
|
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 | |
|
Montante
|
project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
project.funding | number |
O financiamento. |
|
Objetivo
|
project.goal | integer |
O objetivo. |
|
ID
|
project.id | string |
O identificador único. |
|
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 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. |
|
Aviso
|
project.notice | string |
O edital. |
|
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. |
|
Country
|
project.organization.country | string |
O país. |
|
ID
|
project.organization.id | integer |
O identificador único. |
|
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 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 URL. |
|
Link do Relatório de Progresso
|
project.progressReportLink | string |
Ligação para o relatório intercalar. |
|
Link do Projeto
|
project.projectLink | string |
O link do projeto. |
|
Restantes
|
project.remaining | string |
O restante. |
|
Situação
|
project.status | string |
O status. |
|
Resumo
|
project.summary | string |
O sumário. |
|
Nome do tema
|
project.themeName | string |
O nome do tema. |
|
Theme
|
project.themes.theme | array of object | |
|
ID
|
project.themes.theme.id | integer |
O identificador único. |
|
Nome
|
project.themes.theme.name | string |
O nome. |
|
Title
|
project.title | string |
O título. |
Obter projetos em destaque
Esta ação recupera informações para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são rodados por hora com base no ranking GlobalGiving e em um algoritmo de "randomização".
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter regiões
Esta ação recupera todas as regiões.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Região
|
regions.region | array of object | |
|
Nome
|
regions.region.name | string |
O nome. |
Obter resumo de todos os projetos
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se 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. |
|
Country
|
projects.project.country | string |
O país. |
|
Opção de Doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 para um país ou região
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
iso3166CountryCode | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se 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. |
|
Country
|
projects.project.country | string |
O país. |
|
Opção de Doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 dos projetos em destaque
Esta ação recupera informações resumidas para projetos em destaque. O conjunto de resultados sempre retornará 10 resultados. Os projetos em destaque são rodados por hora com base no ranking GlobalGiving e em um algoritmo de "randomização".
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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
Esta ação exibe um subconjunto das informações completas do projeto para um projeto específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
projectid | True | integer |
O identificador único da campanha. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
project.active | boolean |
Se ativo. |
|
Country
|
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 | |
|
Montante
|
project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
project.id | integer |
O identificador único. |
|
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. |
|
Country
|
project.organization.country | string |
O país. |
|
ID
|
project.organization.id | integer |
O identificador único. |
|
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 URL. |
|
Theme
|
project.organization.themes.theme | array of object | |
|
ID
|
project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
project.themes.theme | array of object | |
|
ID
|
project.themes.theme.id | integer |
O identificador único. |
|
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
Esta ação recupera todos os temas GlobalGiving com seus IDs de projeto associados.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Theme
|
themes.theme | array of object | |
|
ID
|
themes.theme.id | integer |
O identificador único. |
|
Nome
|
themes.theme.name | string |
O nome. |
|
projecto
|
themes.theme.projects.project | array of object |
Projeto. |
|
ID
|
themes.theme.projects.project.id | integer |
O identificador único. |
|
Número encontrado
|
themes.theme.projects._numberFound | integer |
O número encontrado. |
|
Texto
|
themes.theme.projects.__text | string |
O texto |
Obter temas GlobalGiving
Esta ação recupera todos os temas do GlobalGiving .
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Theme
|
themes.theme | array of object | |
|
ID
|
themes.theme.id | integer |
O identificador único. |
|
Nome
|
themes.theme.name | string |
O nome. |
Obter todas as informações de resumo do projeto para o conjunto de IDs do projeto
Esta ação recupera um subconjunto das informações completas do projeto para projetos filtrados por uma lista de ids de projeto separadas por vírgula. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IDs do projeto
|
projectIds | string |
Os identificadores únicos do projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
Obter todas as informações do projeto para um conjunto de IDs de projeto
Esta ação recupera informações para projetos filtrados por uma lista de ids de projeto separadas por vírgula. O conjunto de resultados é limitado a um máximo de 10 resultados para uma solicitação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IDs do projeto
|
projectIds | string |
Os identificadores únicos do projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo 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. |
|
Country
|
projects.project.countries.country | array of object | |
|
ISO3166 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. |
|
Country
|
projects.project.country | array of string |
O(s) país(es). |
|
Opção de Doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.description | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
Link da imagem
|
projects.project.imageLink | string |
O link para a imagem. |
|
ISO3166 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. |
|
Country
|
projects.project.organization.country | array of string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
Código do país
|
projects.project.organization.iso3166CountryCode | string |
O ISO3166 código do país. |
|
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. |
|
Correios
|
projects.project.organization.postal | string |
O código postal. |
|
Total de Projetos
|
projects.project.organization.totalProjects | string |
O total dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
projects.project.organization.countries.country | array of object | |
|
Código do país
|
projects.project.organization.countries.country.iso3166CountryCode | string |
O ISO3166 código do país. |
|
Nome
|
projects.project.organization.countries.country.name | string |
O nome. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Nome do tema
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 IDs de projetos
Esta ação recupera todas as IDs de projeto disponíveis.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Projeto
|
projects.project | array of object | |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos
Esta ação recupera informações de 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um país ou região
Esta ação recupera informações sobre todos os projetos num país ou região específicos. 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
iso3166CountryCode | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo da campanha
Esta ação recupera um subconjunto das informações completas do projeto para todos os projetos de 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaignId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se 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. |
|
Country
|
projects.project.country | string |
O país. |
|
Opção de Doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
OrganizationId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para um resumo do tema
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
themeId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se 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. |
|
Country
|
projects.project.country | string |
O país. |
|
Opção de Doação
|
projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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
Esta ação recupera informações para todos os projetos de 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
themeId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | string |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para uma campanha
Esta ação recupera informações sobre todos os projetos da 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaignId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | string |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 URL. |
|
Número encontrado
|
projects._numberFound | integer |
O número de resultados encontrados. |
Obter todos os projetos para uma organização
Esta 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 estã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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
OrganizationId | True | string |
O identificador único da campanha. |
|
Próximo ID do Projeto
|
nextProjectId | integer |
O identificador exclusivo do próximo projeto. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem Seguinte
|
projects.hasNext | boolean |
Se há uma próxima página. |
|
Próximo ID do Projeto
|
projects.nextProjectId | integer |
O identificador do próximo projeto. |
|
Active
|
projects.project.active | boolean |
Se está ativo. |
|
Activities
|
projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
A linha de endereço 2 do contato. |
|
Cidade de contato
|
projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
projects.project.contactCountry | string |
O país do contacto. |
|
Nome do contato
|
projects.project.contactName | string |
O nome do contato. |
|
Entre em contato com os Correios
|
projects.project.contactPostal | string |
O contato é postal. |
|
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 |
O URL do contato. |
|
Country
|
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 | |
|
Montante
|
projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
projects.project.donationOptions.donationOption.title | string |
A descrição. |
|
Financiamento
|
projects.project.funding | number |
O financiamento. |
|
Objetivo
|
projects.project.goal | integer |
O objetivo. |
|
ID
|
projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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 de Modificação
|
projects.project.modifiedDate | string |
A data de modificação. |
|
Necessidade
|
projects.project.need | string |
A necessidade. |
|
Aviso
|
projects.project.notice | string |
O edital. |
|
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. |
|
Country
|
projects.project.organization.country | string |
O país. |
|
ID
|
projects.project.organization.id | integer |
O identificador único. |
|
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 dos projetos. |
|
URL
|
projects.project.organization.url | string |
O endereço URL. |
|
Theme
|
projects.project.organization.themes.theme | array of object | |
|
ID
|
projects.project.organization.themes.theme.id | integer |
O identificador único. |
|
Nome
|
projects.project.organization.themes.theme.name | string |
O nome. |
|
Country
|
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 |
Ligação para o relatório intercalar. |
|
URL do projeto
|
projects.project.projectLink | string |
O link do projeto. |
|
Região
|
projects.project.region | string |
A região. |
|
Restantes
|
projects.project.remaining | string |
O restante. |
|
Situação
|
projects.project.status | string |
O status. |
|
Resumo
|
projects.project.summary | string |
O sumário. |
|
Theme
|
projects.project.themeName | string |
O nome do tema. |
|
Theme
|
projects.project.themes.theme | array of object | |
|
ID
|
projects.project.themes.theme.id | integer |
O identificador único. |
|
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 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. Uma vez 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 do token de acesso são definidos individualmente para cada usuário da API como uma configuração de banco de dados e, por padrão, são definidos como 10 horas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de e-mail da conta. |
||
|
Palavra-passe
|
password | string |
A senha da conta. |
|
|
Chave de API
|
api_key | string |
A chave da API da conta. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Token de Acesso
|
auth_response.access_token | string |
O token de acesso. |
Pesquisar projetos
Esta ação permite pesquisar projetos utilizando palavras-chave.
Parâmetros
| Name | Chave | Necessá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 do filtro. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
search.request.filters.filter.name | string |
O nome. |
|
Valor
|
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 sumário. |
|
Active
|
search.response.projects.project.active | boolean |
Se ativo. |
|
Activities
|
search.response.projects.project.activities | string |
As atividades. |
|
Documentação adicional
|
search.response.projects.project.additionalDocumentation | string |
Qualquer documentação adicional. |
|
Data de aprovação
|
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 |
Endereço do contacto2. |
|
Cidade de contato
|
search.response.projects.project.contactCity | string |
A cidade do contato. |
|
País de Contacto
|
search.response.projects.project.contactCountry | string |
O país do contacto. |
|
E-mail de contacto
|
search.response.projects.project.contactEmail | string |
O e-mail do contato. |
|
Contato
|
search.response.projects.project.contactName | string |
O nome do contato. |
|
Telefone de Contacto
|
search.response.projects.project.contactPhone | string |
O telefone do contato. |
|
Entre em contato com os Correios
|
search.response.projects.project.contactPostal | integer |
O contato é postal. |
|
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 URL do contato. |
|
Country
|
search.response.projects.project.country | string |
O país. |
|
Opção de doação.
|
search.response.projects.project.donationOptions.donationOption | array of object | |
|
Montante
|
search.response.projects.project.donationOptions.donationOption.amount | number |
O montante. |
|
Description
|
search.response.projects.project.donationOptions.donationOption.description | string |
A descrição. |
|
Financiamento
|
search.response.projects.project.funding | number |
O financiamento. |
|
Objetivo
|
search.response.projects.project.goal | integer |
O objetivo. |
|
ID
|
search.response.projects.project.id | integer |
O identificador único. |
|
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 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 único. |
|
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. |
|
Country
|
search.response.projects.project.organization.country | string |
O país. |
|
ID
|
search.response.projects.project.organization.id | string |
O identificador único. |
|
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 |
Ligação para o relatório intercalar. |
|
Link do Projeto
|
search.response.projects.project.projectLink | string |
O link do projeto. |
|
Região
|
search.response.projects.project.region | string |
A região. |
|
Restantes
|
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 sumário. |
|
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. |