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

Opinions List

GET https://api.betterplace.org/de/api_v4/projects/1114/opinions.json?order=created_at%3AASC

A list of betterplace.org projects opinions (donate money). (There is no details view for opinions.)

GET https://api.betterplace.org/de/api_v4/fundraising_events/19267/opinions.json?facets=has_message:true&order=created_at:AASC

A list of betterplace.org fundraising event opinions (donate money).

Results are contained in a data attribute.

URL Parameters

Parameter Example Required Description
project_id 1114 no

Project id as an integer number ≥ 14. This parameter is required in case you want to show project opinions. Also check the URL example in the introduction.

fundraising_event_id 19267 no

Fundraising Event id as an integer number ≥ 1. This parameter is required in case you want to show fundraising event opinions. Also check the URL example in the introduction.

order created_at:ASC no

Order the result set.
It is strongly recommended to specify an order with each request. The default order might change at any time without notice. A recommended order is id:DESC. This is the order in for the opinions list
Supported orders are:

  • created_at:ASC/DESC
  • updated_at:ASC/DESC
  • id:ASC/DESC
  • amount_in_cents:ASC/DESC
It is possible to set multiple order parameters. Learn how to format the parameter.

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)

donated_amount_in_cents number 5000

The amount donated, but only if the user allowed the amount to be visible. Most donation forms allow the donor to specify if they want their amount to be visible. As a default, the donated amount is visible.

Known issue: For forwarding donations (money that is forwarded from a fundraising event to a project) this field is always empty, which is wrong.

matched_amount_in_cents number 5000

If a matching fund was active during the donation then the amount donated by a user might was matched with another donation.

This amount is normally as high as the actual donation amount, with some restrictions, e.g. when the matching fund is depleted or the donation was higher than the maximum matching threshold.

matched boolean true

The matched field is true if this is a donor opinion for a donation that was matched by a matching fund. It's false otherwise.

score string positive

DEPRECATED 2017-06-16 - Always returns "positive"

↓author null | object TODO

The author. DonorOpinion may be anonymous, PlainOpinions and VisitorOpinion require a logged in user.

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

An optional message users can provide to tell others why they like or dislike this project.

The body may contain html such as links, embedded videos, and picture or any of the following HTML tags: b, br, em, i, li, ol, p, strong, ul.

↑Nested Attributes: author

Attribute Types Example Description
author.id number 1

An integer number ≥ 1

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

↓author.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: author.picture

Attribute Types Example Description
author.picture.fallback boolean true

Specifies whether a fallback image is given or not

Response Links

Linkname Description

project

Link to the project this opinion belongs to (project details)

fundraising_event

Link to the fundraising event this opinion belongs to (fundraising event details)

matching_fund

Link to the matching fund that matched this donation. (matching fund details)

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

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

author.picture.fill_100x100

100×100 Pixel

author.picture.original

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

Response Example

{
  "total_entries": 1,
  "offset": 0,
  "total_pages": 1,
  "current_page": 1,
  "per_page": 3,
  "data": [
    {
      "id": 357891,
      "created_at": "2012-04-19T16:08:51+02:00",
      "updated_at": "2016-11-28T15:40:02+01:00",
      "matched": false,
      "score": "positive",
      "author": {
        "name": "Benjamin König",
        "picture": {
          "links": [
            {
              "rel": "fill_100x100",
              "href": "https://betterplace-assets.betterplace.org/uploads/donation/profile_picture/d94/884/32c58c9bb85f004661cfa5bdc614e0dc2/fill_100x100_bp1480344002_crop_original_bp1469459430_20160505-DSC_0627.jpg"
            },
            {
              "rel": "original",
              "href": "https://betterplace-assets.betterplace.org/uploads/donation/profile_picture/d94/884/32c58c9bb85f004661cfa5bdc614e0dc2/crop_original_bp1480344002_crop_original_bp1469459430_20160505-DSC_0627.jpg"
            }
          ]
        },
        "links": [

        ]
      },
      "message": "",
      "links": [
        {
          "rel": "project",
          "href": "https://api.betterplace.org/de/api_v4/projects/9241.json"
        }
      ]
    }
  ]
}