Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
279 lines (215 sloc) 6.15 KB

Matching Fund Details ⇄ List

GET https://api.betterplace.org/de/api_v4/matching_funds/2.json

The details of a betterplace.org matching fund. The details and list view show the same data.

URL Parameters

Parameter Example Required Description
id 2 yes

matching-fund-id as an integer number ≥ 9.

Response Attributes

Root Attributes

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)

activated_at null | string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

title string ACME Matching Everything

Our matching fund's name

description string It's all about matching donations…

The description of the matching fund

company_name string ACME

The company that supports it

client_id string clientname

The client to which the matching fund belongs

provided_amount_in_cents number 12300

The amount in cents the company provided to be matched

donated_amount_in_cents number 12300

The amount in cents the company already donated

state string activated

Current state of this matching fund: either activated or closed

logo_url string http://example.com/images/logo.png

The URL of the logo image.

maximum_matching_amount_in_cents number 10000

Up to this amount donations get matched by the matching fund

Response Links

Linkname Description

self

Link to this resource itself (matching fund details)

platform

Permalink to betterplace.org

projects

Link to the list of projects belonging to this matching fund

documentation

Link to this resource in the documentation

Response Example

{
  "id": 2,
  "created_at": "2013-10-14T15:26:19+02:00",
  "updated_at": "2016-10-27T16:34:11+02:00",
  "activated_at": "2013-10-21T09:54:41+02:00",
  "title": "Jetzt mitmachen – OTTO verdoppelt jede Spende!",
  "description": "### OTTO hilft Hamburgs Stadtgrün – helfen Sie mit!\n\nGemeinsam mit der Loki Schmidt Stiftung und der Stadt Hamburg schließen wir Baumlücken in strukturschwachen Stadtteilen. Diese Lücken entstehen aufgrund von Krankheiten oder mangelnder Standfestigkeit der Straßenbäume.\n\n<img src=\"https://download.betterplace.org/matching-funds/mf_2-otto_description-logos.png\" alt=\"\">\n\nSeit 2011 sind Hamburger Bürger aufgerufen, gemeinsam mit den beiden Partner-Organisationen für neue Bäume zu spenden.\n\nBereits in diesem Jahr hat OTTO das Projekt unterstützt und mit 25.000 Euro 50 Baumlücken in Gebieten geschlossen, in denen weniger gespendet wird – nämlich in Mümmelmannsberg, Nettelnburg, Steinbek, Steilshoop und Willhelmsburg!\n\nNun wollen wir noch weitere Bäume pflanzen – und zwar gemeinsam mit Ihnen!\n\n### Das funktioniert folgendermaßen:\n\n1. Sie spenden einen beliebig hohen Betrag auf betterplace.org.  \n2. OTTO verdoppelt Ihren Betrag!  \n3. Sobald durch Sie und OTTO 500 Euro zusammengekommen sind, legt die Stadt Hamburg die restlichen 500 Euro drauf, die für eine Pflanzung notwendig sind.  \n4. Ein Baum wird gepflanzt – Hamburg wird grüner!\n\nIhr Engagement zählt – und OTTO honoriert das mit dieser Verdopplungsaktion bis zu einem Maximalbetrag von 15.000 Euro! Helfen Sie jetzt hier mit!\n\n",
  "company_name": "OTTO",
  "client_id": null,
  "provided_amount_in_cents": 521500,
  "donated_amount_in_cents": 521500,
  "state": "closed",
  "logo_url": "http://www.betterplace.test/uploads/matching_fund/logo/000/000/002/bp1477578851_OTTO_QUADRAT_4c_M-mid.png",
  "maximum_matching_amount_in_cents": 10000,
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/matching_funds/2.json"
    },
    {
      "rel": "platform",
      "href": "https://www.betterplace.org/de/matching-funds/2-otto"
    },
    {
      "rel": "projects",
      "href": "https://api.betterplace.org/de/api_v4/matching_funds/2/projects.json"
    },
    {
      "rel": "documentation",
      "href": "https://github.com/betterplace/betterplace_apidocs/blob/master/sections/matching_fund_details.md"
    }
  ]
}