Fundraising page details

Page and account creation APIs are now unavailable so please consider your use of our APIs and how this affects you. All other APIs will be available until 18 February. If you have any questions please take a look at our Q&A.

Read our Q&A

Documentation

Fundraising page details

This API provides details for a fundraiser's specific fundraising page.

Details returned include fundraiser name, a link to their page, details of any team members, donation totals including and excluding Gift Aid, and the charities they are fundraising for.

The call requires two parameters – the fundraiser resource ID and the page ID.

The fundraiser resource ID is returned when an account is created and returned via the fundraiser search API and is presented to the fundraiser when signed in to their VMG account.

The page ID can obtained from the fundraiser details API which returns a list of a fundraiser's pages.

URL

Operation type: GET

https://api.virginmoneygiving.com/fundraisers/v1/account/{resourceId}/pages/{pageId}.json?api_key={your API key}

Parameter	Required	Data type	Description
resourceId	True	Varchar(36)	This is the unique account reference for a fundraiser.
pageId	True	Varchar(1)	This identifies an individual page held by the fundraiser.
api_key	True	Varchar(24)	This is your key that allows you access to the VMG APIs.

Response

Outcome	Further information
Success	Status 200: OK Page details, in the following order: Fundraiser title Fundraiser first name Fundraiser surname Fundraiser resource ID Fundrasier page URL Fundraiser API link Page name Page URL Page closed indicator Team name If the page is for a team, the following repeats for each team member: Member title Member first name Member surname Member URI Page details continued: URL to fundraiser image Event name Activity type / description Activity date Total raised (net) Total Gift Aid Total raised (inc. Gift Aid) Offline amount Total raised (inc. Gift Aid and offline amount) Number of donations received for this activity Fundraising target Charity details: Charity name
Error	Sample error: If no fundraiser exists for the values passed, the following error will be returned: Error code: 001.02.004 Error message: No fundraiser page found for supplied search criteria Click here for a full list of API error codes.

Outcome

Further information

Success

Status 200: OK

Page details, in the following order:

Fundraiser title
Fundraiser first name
Fundraiser surname
Fundraiser resource ID
Fundrasier page URL
Fundraiser API link
Page name
Page URL
Page closed indicator
Team name

If the page is for a team, the following repeats for each team member:

Member title
Member first name
Member surname
Member URI

Page details continued:

URL to fundraiser image
Event name
Activity type / description
Activity date
Total raised (net)
Total Gift Aid
Total raised (inc. Gift Aid)
Offline amount
Total raised (inc. Gift Aid and offline amount)
Number of donations received for this activity
Fundraising target

Charity details:

Charity name

Error

Sample error:

If no fundraiser exists for the values passed, the following error will be returned:

Error code: 001.02.004
Error message: No fundraiser page found for supplied search criteria

Click here for a full list of API error codes.

Response description

Parameter	Data type	Description
fundraiserName	Varchar(122)	This is the title, first and last name of the fundraiser.
title	Varchar(20)	This is the title of the fundraiser – Mr, Mrs etc.
forename	Varchar(50)	The first name of the fundraiser.
surname	Varchar(50)	The last name of the fundraiser.
resourceId	Varchar(36)	This is the resource ID of the fundraiser.
personalUrl	Varchar(45)	This is the URL for the fundraiser's VMG account, which will show any fundraising pages they have.
fundraiserURI	Varchar(100)	This is the API link to the fundraiser in the VMG system. For use with the fundraiser details API.
pageName	Varchar(45)	This is the name of the specific fundraising page and is distinct from any others in the same account.
pageUrl	Varchar(100)	This is the API link to the specific fundraising page.
pageClosedIndicator	Varchar(1)	This is set to ‘Y’ if the page is closed and ‘N’ if it is open.
eventName	Varchar(255)	If the page has been set up against an event within VMG, the Virgin Money London Marathon for instance, this is the name of the event from the VMG system.
activityDescription	Varchar(255)	A description of the fundraising activity.
activityDate	Datetime	This is the date the fundraising event or activity is taking place.
teamPage	Varchar(5)	This is set to ‘true’ for team pages and ‘false’ for individual pages.
teamName	Varchar(45)	The name of the fundraising team.
For team pages, the following repeats for each team member:
resourceId	Varchar(36)	This is the resource ID of the individual fundraiser.
title	Varchar(20)	This is the title of the fundraiser – Mr, Mrs etc.
forename	Varchar(50)	The first name of the fundraiser.
surname	Varchar(50)	The last name of the fundraiser.
resourceId	Varchar(36)	This is the resource ID of the fundraiser.
memberUri	Varchar(100)	This is the API link to the individual fundraiser in the VMG system. For use with the fundraiser details API
Fundraising page details continued:
pageImageSmall	Varchar(100)	This is the link to the small fundraiser image.
pageImageMedium	Varchar(100)	This is the link to the medium fundraiser image.
pageImageLarge	Varchar(100)	This is the link to the large fundraiser image.
donationTotalNet	Decimal(19,2)	This is the donation total for the page, excluding Gift Aid and any offline donation amount.
totalGiftAid	Decimal(19,2)	This is the Gift Aid amount applied to the page.
donationTotalGA	Decimal(19,2)	This is the donation total including Gift Aid and excluding any offline donation amount.
offlineAmount	Decimal(19,2)	This is the total amount of donations that have not gone through the fundraising page but have been collected elsewhere.
donationTotalGross	Decimal(19,2)	This is the donation total for the page, including Gift Aid and any offline donation amount.
numberOfDonations	Int(10)	This is a count of the donations that have been applied to the page.
targetAmount	Decimal(19,2)	This is the amount the fundraiser is hoping to raise.
Charity details – the following repeats for each charity:
name	Varchar(150)	This is the name of the charity the page is fundraising for.

XML response example

<fundraiserDetail>
    <fundraiserName>Mr John Smith</fundraiserName>
    <title>Mr</title>
    <forename>John</forename>
    <surname>Smith</surname>
    <resourceId>5d5a0d02-b702-11e2-aba0-00237d9ded4e</resourceId>
    <personalUrl>http://uk.virginmoneygiving.com/MyNewWebAddress</personalUrl>
    <fundraiserURI>https://api.virginmoneygiving.com/fundraisers/v1/account/6397a698-b702-11e2-aba0-00237d9ded4e</fundraiserURI>
    <pageDetails>
        <page>
            <pageName>John Smith's fundraising page</pageName>
            <pageUrl>http://uk.virginmoneygiving.com/fundraiser-display/showROFundraiserPage?userUrl=MyNewWebAddress&pageUrl=3</pageUrl>
            <eventName>Event 10300</eventName>
            <activityDate>20130209</activityDate>
            <teamPage>false</teamPage>
            <teamMembers/>
            <donationTotalNet>28.76</donationTotalNet>
            <totalGiftAid>7.20</totalGiftAid>
            <donationTotalGA>35.96</donationTotalGA>
            <offlineAmount>0.00</offlineAmount>
            <donationTotalGross>35.96</donationTotalGross>
            <numberOfDonations>3</numberOfDonations>
            <targetAmount>0.00</targetAmount>
            <charityDetails>
                <charity>
                    <name>TEST-Virgin Unite</name>
                </charity>
            </charityDetails>
        </page>
    </pageDetails>
</fundraiserDetail>

JSON response example

{
    "fundraiserName": "Mr John Smith",
    "title": "Mr",
    "forename": "John",
    "surname": "Smith",
    "resourceId": "5d5a0d02-b702-11e2-aba0-00237d9ded4e",
    "personalUrl": "http://uk.virginmoneygiving.com/MyNewWebAddress",
    "fundraiserURI": "https://api.virginmoneygiving.com/fundraisers/v1/account/5d5a0d02-b702-11e2-aba0-00237d9ded4e",
    "pageDetails": [{
        "pageName": "John Smith's fundraising page",
        "pageUrl": "http://uk.virginmoneygiving.com/fundraiser-display/fundraiser/showFundraiserPage?userUrl=MyNewWebAddress&pageUrl=3",
        "pageClosedIndicator": null,
        "eventName": "Event 10300",
        "activityDescription": null,
        "activityDate": "20130209",
        "teamPage": false,
        "teamName": null,
        "teamMembers": [],
        "pageImageSmall": "http://uk.virginmoneygiving.com/resources/fundraiser-images/74x922aa63b6e-2d2f-4f19-8542-e8f7ceedaa36.jpg",
        "pageImageMedium": "http://uk.virginmoneygiving.com/resources/fundraiser-images/100x1002aa63b6e-2d2f-4f19-8542-e8f7ceedaa36.jpg",
        "pageImageLarge": "http://uk.virginmoneygiving.com/resources/fundraiser-images/167x1872aa63b6e-2d2f-4f19-8542-e8f7ceedaa36.jpg",
       "donationTotalNet": 28.76,
        "totalGiftAid": 7.20,
        "donationTotalGA": 35.96,
        "offlineAmount": 0.00,
        "donationTotalGross": 35.96,
        "numberOfDonations": 3,
        "targetAmount": 0.00,
        "charityDetails": [{
            "name": "Test Charity"
        }]
    }]
}

version 39 as of 2 years ago by marc

Fundraising page details

Documentation

Fundraising page details

URL

Response

Response description

XML response example

JSON response example

Docs Navigation