- Previous: Charity fundraisers V2
- Up: Introduction
- Next: Authentication
Charity 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.
Documentation
Charity details
This API returns, for a charity's unique reference, details relating to the charity. This allows a fundraiser to select a charity/charities to fundraise for when creating a page.
URL
Operation type: Get
https://api.virginmoneygiving.com/charities/v1/account/{charity resource id}.json?api_key=[your API key]
Parameter | Required | Data type | Description |
---|---|---|---|
charityResourceId | True | Varchar(36) | This is the unique resource ID of the charity. |
api_key | True | Varchar(24) | This is your key that allows you access to the VMG APIs. |
Response
Outcome | Further information |
---|---|
Success |
If the charity resource ID matches an entry in the database then the following is returned:
Charity details, in the following format:
|
Error |
Sample error: If no matching charity is found then the following is returned:
Click here for a full list of API error codes. |
Response description
Data item | Data type | Description |
---|---|---|
name | Varchar(152) | This is the full name of the charity. |
registeredCharityNumber | Varchar(45) | This is the charity's registration number. |
resourceId | Varchar(45) | This is the unique resource ID of the charity. |
logoURL | Varchar(100) | This is the path to the charity's logo. |
charityurl | Varchar(100) | This is the URL to the charity's home page on VMG. |
description | Varchar(1024) | A description of the charity. |
XML response example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <charityDetails> <name>Test Charity</name> <registeredCharityNumber>1234567</registeredCharityNumber> <resourceId>70329eb2-b702-11e2-aba0-00237d9ded4e</resourceId> <logoURL>http://uk.virginmoneygiving.com/resources/charity-logo/187x1671001106_47bbccfa-e806-4f2a-b544-442ed30bfcc0_2008_08_05.testimage.jpg</logoURL> <charityURL>http://uk.virginmoneygiving.com/charities/TestCharity</charityURL> <description>A description of Test Charity.</description> </charityDetails>
JSON response example
{ "name": "Test Charity", "registeredCharityNumber": "1234567", "resourceId": "70329eb2-b702-11e2-aba0-00237d9ded4e", "logoURL": "http://uk.virginmoneygiving.com/resources/charity-logo/187x1671001106_47bbccfa-e806-4f2a-b544-442ed30bfcc0_2008_08_05.testimage.jpg", "websiteURL": null, "charityURL": "http://uk.virginmoneygiving.com/charities/TestCharity", "description": "A description of Test Charity." }
- Previous: Charity fundraisers V2
- Up: Introduction
- Next: Authentication
Docs Navigation
- Introduction
- Getting started
- Fundraiser search
- Fundraiser details
- Fundraiser details V2
- Fundraising page details
- Fundraising page details V2
- Charity search
- Validate URL
- Country code lookup
- Address lookup
- Account Exists
- Create fundraiser account
- Activity lookup
- Event search
- Create fundraiser page
- Event summary
- Event fundraisers
- Event Fundraisers V2
- Event fundraisers 2
- Event fundraisers 2 V2
- Charity fundraisers
- Charity fundraisers V2
- Charity details
- Authentication
- Useful information
- Error codes
- Glossary
- Software development kit