Charity fundraisers V2

This API provides a list of fundraisers who are raising money for the charity resource ID passed. By adding the sort parameters given below, this API can be customised, e.g. to return the top 10 fundraisers by donation value.

Changes from V1 to V2

We have made the fundraiser's title and team member title's optional as we have changed our fundraiser journey to not need these. If you have an existing title with us this will still come through.

Fundraiser accounts now have profile images and their pages have cover images, we return these in this API.

Results pages

As it's possible for a large number of fundraisers to be fundraising for a charity, we restrict the amount of data returned by each API. The numRecords parameter determines the maximum number of rows to return on each call. If this is not passed then the system default (20) is used. To help you move through the dataset the response contains navigation links given below.

Result sorting

The sort order and amount of data returned can be controlled by the following parameters:

• sortOrder - determines the sequence the data is returned in, ascending (A) or descending (D).
• sortField - determines which field to sort on.
• numRecords - determines the number of records to return on each page.
• startRecordNum - is the record number of the first record to return.

The parameter's case must be the same as given above.

So if an event's top 10 fundraisers (or a charity's top 10 for an event) were required, the following parameters should be set:

• sortOrder=D
• sortField=totalDonationGA
• numRecords=10

URL

Operation type: GET

Call with defaults:
https://api.virginmoneygiving.com/charities/v2/account/{charity resource id}/pages.json?api_key={your API key}

Call to provide top 10 fundraisers for a charity:
https://api.virginmoneygiving.com/charities/v2/account/{charity resource id}/pages.json?sortOrder=D&sortField=donationTotalGA&numRecords=10&api_key={your API key}

Response

Response description

Navigation links

The response also contains navigation links.

To prevent excessive load on our servers this API returns pages of data rather than the complete data set. To help you retrieve data this API returns the following navigation links:

Example links:

http://api.virginmoneygiving.com/charities/v2/account/6ec5ad6c-b702-11e2-aba0-00237d9ded4e/pages?startRecordNum=1&numRecords=20>;rel="first"

http://api.virginmoneygiving.com/charities/v2/account/6ec5ad6c-b702-11e2-aba0-00237d9ded4e/pages?startRecordNum=1&numRecords=20>; rel="prev"

http://api.virginmoneygiving.com/charities/v2/account/6ec5ad6c-b702-11e2-aba0-00237d9ded4e/pages?startRecordNum=22&numRecords=20>; rel="next"

http://api.virginmoneygiving.com/charities/v2/account/6ec5ad6c-b702-11e2-aba0-00237d9ded4e/pages?startRecordNum=-1&numRecords=20>; rel="last"

XML response example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fundraiserDetailsV2>
    <fundraiserDetail>
        <fundraiserName>Mr John Smith</fundraiserName>
        <title>Mr</title>
        <forename>John</forename>
        <surname>Smith</surname>
        <resourceId>6461f218-b702-11e2-aba0-00237d9ded4e</resourceId>
        <personalUrl>http://uk.virginmoneygiving.com/JohnSmith</personalUrl>
        <fundraiserURI>https://api.virginmoneygiving.com/fundraisers/v2/account/6461f218-b702-11e2-aba0-00237d9ded4e</fundraiserURI>
        <pageDetails>
            <page>
                <pageName>John Smith's fundraising page</pageName>
                <pageUrl>http://uk.virginmoneygiving.com/fundraiser-display/showROFundraiserPage?userUrl=JohnSmith&pageUrl=2</pageUrl>
                <pageClosedIndicator>N</pageClosedIndicator>
                <eventName>Test Event</eventName>
                <eventResourceId>6ec58742-b702-11e2-aba0-00237d9ded4e</eventResourceId>
                <activityDate>20130728</activityDate>
                <teamPage>false</teamPage>
                <teamPage>false</teamPage>
                <teamMembers/>
                <donationTotalNet>0.00</donationTotalNet>
                <totalGiftAid>0.00</totalGiftAid>
                <donationTotalGA>0.00</donationTotalGA>
                <offlineAmount>0.00</offlineAmount>
                <donationTotalGross>0.00</donationTotalGross>
                <numberOfDonations>0</numberOfDonations>
                <targetAmount>0.00</targetAmount>
                <charityDetails>
                    <charity>
                        <name>Test Charity</name>
                    </charity>
                </charityDetails>
            </page>
        </pageDetails>
    </fundraiserDetail>
</fundraiserDetailsV2>

JSON response example

{
    "fundraiserDetailsV2": [{
        "fundraiserName": "Mr John Smith",
        "title": "Mr",
        "forename": "John",
        "surname": "Smith",
        "resourceId": "633969d4-b702-11e2-aba0-00237d9ded4e",
        "personalUrl": "http://uk.virginmoneygiving.com/JohnSmith",
        "fundraiserURI": "https://api.virginmoneygiving.com/fundraisers/v2/account/633969d4-b702-11e2-aba0-00237d9ded4e",
        "pageDetails": [{
            "pageName": "John Smith's Fundraising page",
            "pageUrl": "http://uk.virginmoneygiving.com/fundraiser-display/showROFundraiserPage?userUrl=JohnSmith&pageUrl=2",
            "pageClosedIndicator": "N",
            "eventName": "Test Event",
            "eventResourceId": "6ec58742-b702-11e2-aba0-00237d9ded4e",
            "activityDescription": null,
            "activityDate": "20130728",
            "teamPage": false,
            "teamName": null,
            "teamMembers": [],
            "profileImageSmall": "http://uk.virginmoneygiving.com/resources/fundraiser-images/74x926397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "profileImageMedium": "http://uk.virginmoneygiving.com/resources/fundraiser-images/100x1006397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "profileImageLarge": "http://uk.virginmoneygiving.com/resources/fundraiser-images/167x1876397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "coverImageSmall": "http://uk.virginmoneygiving.com/resources/fundraiser-images/960x6006397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "coverImageMedium": "http://uk.virginmoneygiving.com/resources/fundraiser-images/960x6006397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "coverImageLarge": "http://uk.virginmoneygiving.com/resources/fundraiser-images/2080x9006397a698-b702-11e2-aba0-00237d9ded4e.jpg",
            "donationTotalNet": 0.00,
            "totalGiftAid": 0.00,
            "donationTotalGA": 0.00,
            "offlineAmount": 0.00,
            "donationTotalGross": 0.00,
            "numberOfDonations": 0,
            "targetAmount": 0.00,
            "charityDetails": [{
                "name": "Test Charity"
            }]
        }]
    }]
}