Retrieves details about a specific campaign. Includes summary totals.
REST
Request
https://api.neoncrm.com/neonws/services/api/donation/retrieveCampaignSummary?userSessionId=[session id]&campaignId=3280
Response
{
"retrieveCampaignSummary": {
"operationResult": "SUCCESS",
"responseDateTime": "2014-12-12T21:51:24.000+0000",
"campaign": {
"id": 2,
"name": "Deactivated campaign",
"code": "MYCODE",
"startDate": "2014-11-01T05:00:00.000+0000",
"endDate": "2014-12-26T06:00:00.000+0000",
"fund": {
"id": "1",
"name": "FUN FUND"
},
"purpose": {
"id": "1",
"name": "Porpoise Purpose"
},
"parentCampaign": {
"id": "1",
"name": "dsd"
},
"pageContent": "<p>Campaign page HTML content.</p>",
"status": "ACTIVE",
"goal": 2500,
"donationCount": 1,
"donationAmount": 100,
"pledgeCount": 0,
"pledgeAmount": 0,
"registrationCount": 1,
"registrationAmount": 1200,
"grandTotal": 1300,
"campaignPageLink": "https://www.z2systems.com/np/clients/test/campaign.jsp?campaign=2&",
"donationFormLink": "https://www.z2systems.com/np/clients/test/donation.jsp?campaign=2&",
"socialFundraising": {
"enabled": true,
"fundraisersCount": 3,
"donationAmount": 100,
"pledgeAmount": 0,
"registrationCount": 0,
"registrationAmount": 0,
"grandTotal": 100,
"createFundraiserLink": "https://www.z2systems.com/np/clients/test/publicFundraiserList.jsp?campaignId=2&",
"campaignFundraiserList": "https://www.z2systems.com/np/clients/test/createFundraiser.jsp?campaignId=2&",
"fundraisingPageContent": "<p>Social fundraising page content.</p>"
}
}
}
}
Request Parameters
|
Name |
Required |
Description |
|
campaignId |
Yes |
The ID of the Campaign to be retrieved. |
Response Parameters
|
Name |
Required |
Description |
|
campaign.id |
Yes |
Campaign ID |
|
campaign.name |
Yes |
Campaign name |
|
campaign.code |
|
Campaign code |
|
campaign.startDate |
|
Campaign’s Start Date – Format: yyyy-mm-dd |
|
campaign.endDate |
|
Campaign’s End Date – Format: yyyy-mm-dd |
|
campaign.status |
Yes |
Possible values: Active, Inactive |
|
campaign.goal |
|
Campaign goal. |
|
campaign.donationCount |
Yes |
Total number of donations. |
|
campaign.donationAmount |
Yes |
Total dollar value of donations. |
|
campaign.pledgeCount |
Yes |
Total number of pledges. |
|
campaign.pledgeAmount |
Yes |
Total dollar value of pledges. |
|
campaign.registrationCount |
Yes |
Total number of event registrations. |
|
campaign.registrationTotal |
Yes |
Total value of event registrations. |
|
campaign.attendeeCount |
Yes |
Total number of event attendees. |
|
campaign.grandTotal |
Yes |
Total dollar value of Donations and Event Registrations combined. (Excludes Pledges) |
|
campaign.fund.id |
|
Campaign’s Fund |
|
campaign.fund.name |
|
|
|
campaign.purpose.id |
|
Campaign’s Purpose |
|
campaign.purpose.name |
|
|
|
campaign.parentCampaign.id |
|
ID of the campaign’s parent campaign. |
|
campaign.parentCampaign.name |
|
|
|
campaign.campaignPageLink |
Yes |
URL of public-facing campaign detail page. |
|
campaign.donationFormLink |
Yes |
URL of public-facing campaign donation form. |
|
campaign.pageContent |
|
HTML content of campaign page. |
|
Social Fundraising |
|
|
|
If social fundraising is enabled, the following fields will display. Summary data is specific to those transactions collected through social fundraising forms. |
|
|
|
campaign.socialFundraising.enabled |
Yes |
Possible values: true, false |
|
campaign.socialFundraising.fundraiserCount |
|
|
|
campaign.socialFundraising.donationCount |
|
|
|
campaign.socialFundraising.donationAmount |
|
|
|
campaign.socialFundraising.pledgeCount |
|
|
|
campaign.socialFundraising.pledgeAmount |
|
|
|
campaign.socialFundraising.registrationCount |
|
|
|
campaign.socialFundraising.registrationTotal |
|
|
|
campaign.socialFundraising.attendeeCount |
|
|
|
campaign.socialFundraising.grandTotal |
|
|
|
campaign.socialFundraising.createFundraiserLink |
|
|
|
campaign.socialFundraising.campaignFundraiserList |
|
|
|
campaign.socialFundraising.fundraisingPageContent |
|
|
