Fundraiser details V2

Documentation

Fundraiser details V2

This API returns information about the pages a fundraiser has for a given resource ID.

The API also returns, for each page, a URI link to the fundraiser's page API which, if called, details the pages' donation totals.

Changes from V1 to V2

We have made the fundraiser's title 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.

URL

Operation type: GET

https://api.virginmoneygiving.com/fundraisers/v2/account/{resourceId}?api_key={your API key}

Parameter	Required	Data type	Description
resourceId	True	Varchar(36)	This is the resource ID of the fundraiser.
api_key	True	Varchar (24)	This is your key that allows you access to the VMG APIs.

Response

Outcome	Further information
Success	The following will be returned if the fundraiser exists: Status 200: OK Then fundraiser details in the following format: Name Fundraiser resource id Fundraiser personal URL i.e. http://uk.virginmoneygiving.com/{url} Then a list of their pages. For each page you'll see: Page name Link to fundraiser page Page closed indicator URL to small fundraiser profile image URL to medium fundraiser profile image URL to large fundraiser profile image URL to small fundraiser cover image URL to medium fundraiser cover image URL to large fundraiser cover image
Error	Sample error: If no fundraiser exists for the resource ID passed, the following error will be returned: Error code: 001.02.004 Error message: No fundraiser page found for supplied search criteria {resource ID} Click here for a full list of API error codes.

Outcome

Further information

Success

The following will be returned if the fundraiser exists:

Status 200: OK

Then fundraiser details in the following format:

Name
Fundraiser resource id
Fundraiser personal URL i.e. http://uk.virginmoneygiving.com/{url}

Then a list of their pages. For each page you'll see:

Page name
Link to fundraiser page
Page closed indicator
URL to small fundraiser profile image
URL to medium fundraiser profile image
URL to large fundraiser profile image
URL to small fundraiser cover image
URL to medium fundraiser cover image
URL to large fundraiser cover image

Error

Sample error:

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

Error code: 001.02.004
Error message: No fundraiser page found for supplied search criteria {resource ID}

Click here for a full list of API error codes.

Response description

Data item	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. (optional)
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(45)	This is the API link to the fundraiser in the VMG system.
Repeats for each fundraising page the fundraiser has:
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.
teamPage	Varchar(5)	This is set to ‘true’ for team pages and ‘false’ for individual pages.
profileImageSmall	Varchar(100)	This is the link to the small fundraiser profile image.
profileImageMedium	Varchar(100)	This is the link to the medium fundraiser profile image.
profileImageLarge	Varchar(100)	This is the link to the large fundraiser profile image.
coverImageSmall	Varchar(100)	This is the link to the small fundraiser cover image.
coverImageMedium	Varchar(100)	This is the link to the medium fundraiser cover image.
coverImageLarge	Varchar(100)	This is the link to the large fundraiser cover image.

XML response example

<fundraiserSummary>
    <fundraiserName>Mr John Smith</fundraiserName>
    <title>Mr</title>
    <forename>John</forename>
    <surname>Smith</surname>
    <resourceId>6397a698-b702-11e2-aba0-00237d9ded4e</resourceId>
    <personalUrl>http://uk.virginmoneygiving.com/MyNewWebAddress</personalUrl>
    <fundraiserURI>https://api.virginmoneygiving.com/fundraisers/v2/account/6397a698-b702-11e2-aba0-00237d9ded4e</fundraiserURI>
    <pageSummary>
       <page>
            <pageName>John Smith's fundraising page</pageName>
            <pageUrl>https://api.virginmoneygiving.com/fundraisers/v2/account/6397a698-b702-11e2-aba0-00237d9ded4e/pages/3</pageUrl>
            <pageClosedIndicator>N</pageClosedIndicator>
            <teamPage>true</teamPage>
            <profileImageSmall>http://uk.virginmoneygiving.com/resources/fundraiser-images/74x926397a698-b702-11e2-aba0-00237d9ded4e.jpg</profileImageSmall>
            <profileImageMedium>http://uk.virginmoneygiving.com/resources/fundraiser-images/100x1006397a698-b702-11e2-aba0-00237d9ded4e.jpg</profileImageMedium>
            <profileImageLarge>http://uk.virginmoneygiving.com/resources/fundraiser-images/167x1876397a698-b702-11e2-aba0-00237d9ded4e.jpg</profileImageLarge>
            <coverImageSmall>http://uk.virginmoneygiving.com/resources/fundraiser-images/960x6006397a698-b702-11e2-aba0-00237d9ded4e.jpg</coverImageSmall>
            <coverImageMedium>http://uk.virginmoneygiving.com/resources/fundraiser-images/960x6006397a698-b702-11e2-aba0-00237d9ded4e.jpg</coverImageMedium>
            <coverImageLarge>http://uk.virginmoneygiving.com/resources/fundraiser-images/2080x9006397a698-b702-11e2-aba0-00237d9ded4e.jpg</coverImageLarge>
        </page>
    </pageSummary>
</fundraiserSummary>

JSON response example

{
    "fundraiserName": "Mr John Smith",
    "title": "Mr",
    "forename": "John",
    "surname": "Smith",
    "resourceId": "6397a698-b702-11e2-aba0-00237d9ded4e",
    "personalUrl": "http://uk.virginmoneygiving.com/MyNewWebAddress",
    "fundraiserURI": "https://api.virginmoneygiving.com/fundraisers/v2/account/6397a698-b702-11e2-aba0-00237d9ded4e",
    "pageSummary": [{
        "pageName": "John Smith's fundraising page",
        "pageUrl": "https://api.virginmoneygiving.com/fundraisers/v2/account/6397a698-b702-11e2-aba0-00237d9ded4e/pages/3",
        "pageClosedIndicator": "N",
        "teamPage": true,
        "teamName": null,
        "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"
    }]
}

version 1 as of 1 year ago by VMG Administrator

Fundraiser details V2

Documentation