Fundraising Event Details ⇄ List
GET https://api.betterplace.org/de/api_v4/fundraising_events/19267.jsonThe details of a betterplace.org fundraising events (donate money).
For betterplace.org clients:
Use this resource as follows: /clients/PERMALINK/fundraising-events/ID.json
| Parameter | Example | Required | Description |
|---|---|---|---|
| id | 19267 |
yes |
Fundraising Event id as an integer number ≥ 1. |
| Attribute | Types | Example | Description |
|---|---|---|---|
| id | number |
1 |
An integer number ≥ 1 |
| created_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| updated_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| content_updated_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) |
| title | string |
Gemeinsam gegen Ebola: Deine Spende für Westafrika |
Max 50 character |
| description | string |
Lorem ipsum |
A description of the fundraising event. This may contain any of the
following HTML tags: |
| tax_deductible | boolean |
true |
True if the fundraising event is marked as tax deductible and can only support tax deductible projects. If so, users can request a tax receipt for their donation that can be used with the German tax authorities. |
| donations_prohibited | boolean |
false |
True if the fundraising event must not and cannot receive donations. This might happen if the event was closed by the manager or blocked by a platform administrator. Please check this flag whenever you display a donation button. Should you show a button for an event that cannot receive donations the user will open the donation form and see an error message on betterplace.org instead! |
| closed_at | string |
"1994-11-05T13:15:30Z" |
DateTime (ISO8601 with Timezone) when the fundraising event was closed by the manager. |
| donations_count | number |
42 |
Count of confirmed donations for this fundraising event |
| donor_count | number |
46 |
Number of unique donors, based on the payment-email-address |
| donated_amount_in_cents | number |
232323 |
How many cents were already raised with the fundraising event |
| requested_amount_in_cents | number |
12382 |
How many cents were requested to be raised with the fundraising event. This value is optional! The manager decides if his event has a goal or not. |
| forwarded_amount_in_cents | number |
12382 |
How many cents were already forwarded to a project. |
| progress_percentage | number |
5 |
% financed. This value is only present in case the manager
decided to add a |
| ↓contact | object |
TODO |
The public face of the fundraising event / fundraising event manager |
| ↓profile_picture | null | object |
//betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg |
TODO |
| Attribute | Types | Example | Description |
|---|---|---|---|
| contact.id | number |
1 |
An integer number ≥ 1 |
| contact.name | null | string |
"Till B." |
Display name of a betterplace.org user. Possible formats: "Till B.", "T. Behnke", "Till Behnke". In the case of donation-opinions the name might also be empty/null for anonymous donations for anonymous donations. |
| ↓contact.picture | object |
//betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg |
User profile picture or a fallback image |
| Attribute | Types | Example | Description |
|---|---|---|---|
| contact.picture.fallback | boolean |
true |
Specifies whether a fallback image is given or not |
| Attribute | Types | Example | Description |
|---|---|---|---|
| profile_picture.fallback | boolean |
true |
Specifies whether a fallback image is given or not |
| Linkname | Description |
|---|---|
|
self |
Link to this resource itself (fundraising event details) |
|
featured_projects |
A list of projects are currently supported by the fundraising event. Please note that this project list has no fixed relation to the list of projects that received money by this fundraising event (see Featured Projects List). A Fundraising event manager can change the list of supported projects at any time; regardless if they received money before. |
|
blog_posts |
Link to blog posts list |
|
forwardings |
Provides a list of forwarded amounts and their receiving projects. Each fundraising event can have multiple projects that it supports. The fundraising event manager specifies the amount that is forwarded from the fundraising event to the project. Please note that this list of forwarded donations and their corresponding receiving projects is not required to be in sync with the Featured Project List endpoint. To find out if all donations of the fundraising event have been forwarded, please sum the amounts provided by this api endpoint and compare it to the donated amount attribute of the fundraising event api endpoint. |
|
platform |
Permalink to betterplace.org |
|
opinions |
Link to donations/opinions list |
|
new_client_donation |
Link to the donation form. Templated, needs insertion of the client_id. |
|
new_donation |
Link to the regular donation form. |
|
header_picture |
Optional additional image to be used when promoting the fundraising event. This is an experimental feature. Please use it with caution. We might change or remove it any time without notice. |
|
new_message |
Send message to this fundraising event via betterplace.org |
|
contact.platform |
The user's profile on betterplace.org. To view a user profile you have to be logged in. This array is empty if the user has no useraccount with betterplace.org but donated via one of our partner. |
|
contact.contact_data |
The user's contact data. Please note that you need to be authenticated as a client with matching access rights in order to see this information. |
|
contact.picture.fill_100x100 |
100×100 Pixel |
|
contact.picture.original |
Maximum sized image. This is the original image with default-cropping or user-cropping applied. |
|
profile_picture.fill_960x500 |
950×500 Pixel |
|
profile_picture.fill_730x380 |
730×380 Pixel |
|
profile_picture.fill_618x322 |
618×322 Pixel / DEPRECATED, will be removed after 5/2015 |
|
profile_picture.fill_410x214 |
410×214 Pixel |
|
profile_picture.fill_270x141 |
270×141 Pixel / DEPRECATED, will be removed after 5/2015 |
|
profile_picture.original |
Maximum sized image. This is the original image with default-cropping or user-cropping applied. |
{
"id": 19267,
"created_at": "2014-09-23T21:17:06+02:00",
"updated_at": "2019-05-29T00:45:18+02:00",
"content_updated_at": "2015-06-28T11:32:11+02:00",
"title": "Gemeinsam gegen Ebola: Deine Spende für Westafrika",
"description": "Das Ebola-Virus ist für uns* in Westafrika allgegenwärtig: Schüttelt man zur Begrüßung noch die Hand, obwohl die Regierungen davon abraten? Tritt man die Dienstreise in das vom Virus betroffene Nigeria an? Droht die Quarantäne, wenn man bei der Ausreise aus der Region unter Erkältung und Fieber leidet? <br><br>Für die Menschen in Sierra Leone, Liberia und Guinea sind das Luxusprobleme. Dort ist ein normaler Alltag nicht mehr möglich. Im Familienkreis oder der Nachbarschaft gibt es möglicherweise Tote zu beklagen. Der Zugang zu Gesundheitsdienstleistungen ist, auch für andere häufig auftretende Krankheiten wie Malaria, erschwert und kann teilweise nicht mehr gewährleistet werden. <br><br>Viele Ärzte und Krankenschwestern sind selbst gestorben oder haben Angst, sich selbst anzustecken, da es an grundsätzlichen Dingen wie Schutzkleidung und Arzneimitteln fehlt. Unsere Spenden unterstützen Action Medeor beider Ausrüstung zweier neu aufgebauter Isolierstationen in Monrovia, Liberia.<br><br>Die internationale Gemeinschaft reagiert nur sehr langsam – obwohl das Virus bereits seit Anfang des Jahres mehr als 2500 Menschen den Tod gekostet hat. Die langfristigen Folgen für die Volkswirtschaften, die Gesundheitssysteme und das Zusammenleben der Menschen in der Region sind verheerend. <br><br>Wir müssen jetzt handeln, um den Menschen vor Ort und ihren Helfern die notwendigen Materialien zukommen zu lassen. Wir denken dabei auch an unsere Freunde hier in der Region, die wir auf Dienstreisen kennen gelernt haben oder die als Ärzte in Alarmbereitschaft versetzt wurden. Helft uns dabei, den Menschen in ihrer Notlage zu helfen: Teilt diesen Link mit anderen und spendet, auch kleine Beiträge sind willkommen! <br><br>* Jonas lebt seit mehr als zwei Jahren im Senegal, Johanna war für knapp zwei Monate im benachbarten Gambia. Wir beide haben in den letzten Wochen die Nachrichtenlage verfolgt und mit den Menschen vor Ort über die Unsicherheit gesprochen. <br><br>Bild: Jonas Wipfler, Liberia, 2013",
"tax_deductible": true,
"donations_prohibited": true,
"closed_at": "2015-06-28T11:32:11+02:00",
"donations_count": 134,
"donor_count": 124,
"donated_amount_in_cents": 858280,
"requested_amount_in_cents": null,
"forwarded_amount_in_cents": 858280,
"progress_percentage": null,
"contact": {
"id": 397832,
"name": "Mila Kraus",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/fill_100x100_bp1575697237_JoJo.jpg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/crop_original_bp1575697237_JoJo.jpg"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/397832"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/397832/contact_data.json"
}
]
},
"profile_picture": {
"links": [
{
"rel": "fill_960x500",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/fill_960x500_Liberia_1.jpg"
},
{
"rel": "fill_730x380",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/fill_730x380_Liberia_1.jpg"
},
{
"rel": "fill_618x322",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/fill_618x322_Liberia_1.jpg"
},
{
"rel": "fill_410x214",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/fill_410x214_Liberia_1.jpg"
},
{
"rel": "fill_270x141",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/fill_270x141_Liberia_1.jpg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/fundraising_event/profile_picture/000/019/267/crop_original_Liberia_1.jpg"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/19267.json"
},
{
"rel": "featured_projects",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/19267/featured_projects.json"
},
{
"rel": "blog_posts",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/19267/blog_posts.json"
},
{
"rel": "forwardings",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/19267/forwardings.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/fundraising-events/19267-gemeinsam-gegen-ebola-deine-spende-fuer-westafrika"
},
{
"rel": "opinions",
"href": "https://api.betterplace.org/de/api_v4/fundraising_events/19267/opinions.json"
},
{
"rel": "new_client_donation",
"href": "https://www.betterplace.org/de/donate/%7Bclient_id%7D/fundraising-events/19267",
"templated": true
},
{
"rel": "new_donation",
"href": "https://www.betterplace.org/de/donate/platform/fundraising-events/19267"
},
{
"rel": "new_message",
"href": "https://www.betterplace.org/de/messages/new?recipient=397832"
}
]
}