Get All Projects for a Campaign Summary

This operation retrieves a subset of the full project information for all projects in a specific campaign. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements <hasNext> and <nextProjectId>. Note that these two elements are not present if there are no more available results. The <hasNext> element indicates whether there are more results available and the <nextProjectId> element indicates the next project id to include in the query string to retrieve the next set of results. This is a non-secure request as indicated by the '/public/' element in the URL path, therefore, an access token (authentication) is not required.

HTTP Method:

GET

Content Type:

xml, json

Accept Type:

xml, json

Path:

Path Parameter:

{campaignId} the Campaign identifier for a specific campaign, replace with actual value, required

Query String Parameters:

&api_key described in the API Key section, required

&nextProjectId indicates the next project id to start the result set from, optional

Query String Example:

HTTP GET Request using cURL:

curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET "https://api.globalgiving.org/api/public/projectservice/campaign/187/projects/summary?api_key=YOUR_API_KEY"

XML Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<projects numberFound="12">
   <hasNext>true</hasNext>
   <nextProjectId>364</nextProjectId>
   <project>
      <active>true</active>
    <countries>
      <country>
        <iso3166CountryCode>AF</iso3166CountryCode>
        <name>Afghanistan</name>
      </country>
    </countries>
      <country>Afghanistan</country>
      <donationOptions>
         <donationOption>
            <amount>25</amount>
            <description>15 women will learn to read.</description>
         </donationOption>
         <donationOption>
            <amount>50</amount>
            <description>5 women have cloth and tools for the tailoring course.</description>
         </donationOption>
         <donationOption>
            <amount>75</amount>
            <description>42 women receive basic health care and health education.</description>
         </donationOption>
      </donationOptions>
      <id>354</id>
      <imageLink>https://www.globalgiving.org/pfil/354/pict.jpg</imageLink>
      <iso3166CountryCode>AF</iso3166CountryCode>
      <organization>
          <activeProjects>2</activeProjects>
          <addressLine1>Afghan Institute of Learning c/o Creating Hope International, PO Box 1058</addressLine1>
          <city>Dearborn</city>
          <country>United States</country>
          <id>372</id>
          <iso3166CountryCode>US</iso3166CountryCode>
          <mission>Teaching Afghan Yourth</mission>
          <name>Afghan Institute of Learning</name>
          <state>DC</state>
          <postal>48121</postal>
          <totalProjects>5</totalProjects>
          <url>http://www.creatinghope.org/ail</url>
          <themes>
             <theme>
                <id>edu</id>
                <name>Education</name>
             </theme>
             <theme>
                <id>env</id>
                <name>Environment</name>
             </theme>
          </themes>
          <countries>
             <country>
                <iso3166CountryCode>ID</iso3166CountryCode>
                <name>Indonesia</name>
             </country>
             <country>
                <iso3166CountryCode>NG</iso3166CountryCode>
                <name>Nigeria</name>
             </country>
          </countries>
      </organization>
      <status>active</status>
      <summary>Empowering rural Afghan women and girls in Sar Asia and Jaghartun, Herat, through education and training opportunities as well as health and reproductive health services.</summary>
      <themeName>Education</themeName>
    <themes>
      <theme>
        <id>edu</id>
        <name>Education</name>
      </theme>
      <theme>
        <id>children</id>
        <name>Children</name>
      </theme>
    </themes>
      <title>Learning Centers for Rural Afghan Women in Herat</title>
      <type>project</type>
   </project>
   <project>
      ......
   </project>
</projects>

NOTE: The <project> element is repeating.

See Get All Projects Response Structure

See Element Definitions for Get All Projects Response