Skip to content

Latest commit

 

History

History
443 lines (347 loc) · 9.63 KB

client_donations_list.md

File metadata and controls

443 lines (347 loc) · 9.63 KB

Client Donations List ⇄ Details

GET https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations.json?facets=client_reference%3A922ec9b-etc

For betterplace.org clients only:

This API returns all donations to all client projects that where made using the client donation form (but none of the other donation-sources).

Results are contained in a data attribute.

URL Parameters

Parameter Example Required Description
client_id volksfreund yes

The betterplace.org-internal client permalink.
facets client_reference:922ec9b-etc no

You can search for a specific client_reference: ?facets=client_reference:54


Example: https://api.betterplace.org/en/api_v4/ clients/karmic_minion/ client_donations?facets=client_reference:54
This feature is only used in some cases that relate to the ThirdPartyApp custom donation form for organisations and the Client donation pledge endpoint.

Response Attributes

Root Attributes

Attribute Types Example Description
amount_in_cents number 10100

Donated amount in cents
state string "confirmed"

At the moment, all donations that are returned by the API are "confirmed". Unconfirmed donations do not show up at all or disappear after they were revoked. Revocations usually take place during the first 14 days – but there are no guarantees.

Please make sure to check for the "confirmed" state in your application explicitly since we might add a "revoked" state in the future.
↓donor null | object TODO

Donor information, if available.
message null | string "This is a great project. In spring 2007 I travelled around the area together with my children and …"

An optional message by users.

The body is plain text potentially containing line-breaks.
token string ofMmTgfiPL-n1dDlNmFWqTQN

A token uniquely identifies a donation on the platform.
client_reference string 922ec9b-etc

Client Donations can be identified via a custom client reference token.

This client_reference can be provided by users of our ThirdPartyApp custom donation form for organisations, for example.
created_at string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)
receiver_type string "Project"

Client donations may go to a Project, a FundraisingEvent, a Pool.
receiver_id number 1114

The id of the project, project element or fundraising event.
receiver_title string "Skateistan Afghanistan"

The title of the project, project element or fundraising event.

↑Nested Attributes: donor

Attribute Types Example Description
donor.id number 1

An integer number ≥ 1
donor.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.
↓donor.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

↑Nested Attributes: donor.picture

Attribute Types Example Description
donor.picture.fallback boolean true

Specifies whether a fallback image is given or not

Response Links

Linkname Description

receiver

Link to the project details, project need details, fundraising event details, that is associated with this donation.
Right now, there is no api end point for donations that are redirect or donated to the client pool.

self

Link to this resource itself (client donation details)

donor.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.

donor.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.

donor.picture.fill_100x100

100×100 Pixel

donor.picture.original

Maximum sized image. This is the original image with default-cropping or user-cropping applied.

Response Example

{
  "total_entries": 21545,
  "offset": 0,
  "total_pages": 7182,
  "current_page": 1,
  "per_page": 3,
  "data": [
    {
      "amount_in_cents": 200,
      "state": "confirmed",
      "donor": null,
      "message": "Gemeinsam für Kinder!",
      "token": "c65e1cd3ff166c67adf7",
      "client_reference": null,
      "created_at": "2011-12-13T13:48:15+01:00",
      "receiver_type": "FundraisingEvent",
      "receiver_id": 8821,
      "receiver_title": "Stark fürs Leben - für die Zukunft unserer Kinder",
      "links": [
        {
          "rel": "receiver",
          "href": "https://api.betterplace.org/de/api_v4/fundraising_events/8821.json"
        },
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/c65e1cd3ff166c67adf7.json"
        }
      ]
    },
    {
      "amount_in_cents": 100,
      "state": "confirmed",
      "donor": null,
      "message": "",
      "token": "e0099cc079adbf1c13c0",
      "client_reference": null,
      "created_at": "2012-05-23T16:41:06+02:00",
      "receiver_type": "FundraisingEvent",
      "receiver_id": 9866,
      "receiver_title": "Fab&Vivien Nr. 3 | The third fundraising bet",
      "links": [
        {
          "rel": "receiver",
          "href": "https://api.betterplace.org/de/api_v4/fundraising_events/9866.json"
        },
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/e0099cc079adbf1c13c0.json"
        }
      ]
    },
    {
      "amount_in_cents": 1000,
      "state": "confirmed",
      "donor": null,
      "message": "",
      "token": "cfa60978d12bb91589cf",
      "client_reference": null,
      "created_at": "2012-06-12T16:53:03+02:00",
      "receiver_type": "FundraisingEvent",
      "receiver_id": 10987,
      "receiver_title": "Touchrugbyturnier",
      "links": [
        {
          "rel": "receiver",
          "href": "https://api.betterplace.org/de/api_v4/fundraising_events/10987.json"
        },
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/cfa60978d12bb91589cf.json"
        }
      ]
    }
  ]
}