CHANGELOG.md

Changelog

All notable changes to the betterplace.org API v4 will be documented in this file.

2022-10-24

• Deprecate comments_count on project details. (The comments feature had already been removed in 2021.)

2022-06-09

Removed

• Volunteering endpoint
• Clients Volunteering endpoint

2021-06-08

Changed

• Deprecate donor_count on project details and fundraising events details. We will remove this value after 2021-12-31. Please use donations_count instead.
• Deprecate external_donated_amount_in_cents on client project statistics. We will remove this value in the future.

2020-12-10

Changed

• Only published blog posts will be handed out by the API from now on.

Added

• Added published_at to Blog posts endpoint.
• Added activate_donations_at DateTime to Fundraising events details and updated the donations_prohibited documentation accordingly.

2020-04-30

Added

• Added donor and message to client donations.

2020-03-09

Changed

• Project carrier can be NULL if none was selected. Mostly happens for legacy projects. project details
• carrier now contains its ID as a separate field

2020-01-27

Removed

• Donor contact data endpoint
• Listing of illustrations

2019-02-25

Changed

• Changed behavior of validate_address of donation pledges: first_name, last_name and email won't be validated if set to false

2019-01-28

Added

• Added donation_count to fundraising events details
• Added new_message link to fundraising events details
• Blog posts endpoint is now available for fundraising events as well.
• Extended fundraising event forwarding list, eg. with project name and platform url

2018-06-01

Fixed

• Fixed ordering of opinions for projects and fundraising event
• Fixed has_message facet filter on opinions

2017-08-15

Added

• Added support for tracking_via to donation pledges and forwarding requests.

2017-07-20

Added

• Added summary to project details.

2017-06-16

Added

• Added donations_count integer to project details.
• Added comments_count integer to project details.

Removed

• Removed endpoint for clients

Changed

• Deprecated positive_opinions_count and negative_opinions_count on project as well as positive_or_negative on opinion

2017-03-03

Removed

• Removed [Fundraising Challenge] endpoint

2016-12-05

Added

• Added endpoint for donation pledges.
• Added endpoint for forwarding requests.

2016-12-01

Removed

• [Opinion Details] endpoint removed

2016-06-28

Changed

• Opinion Lists now come with the same default order as opinions on betterplace.org - newest first.

2016-04-18

Added

• Added client API endpoint to submit volunteering inquiries to. See here

2016-04-12

Added

• Volunteering List can now be sorted by the content_updated_at order parameter.

2016-04-11

Changed

• Organisation Details: The description now contains br tags instead of newlines
• Volunteering Details: The description now contains br tags instead of newlines

2016-03-15

Changed

• donation pledges: lowered the minimum value for amount_in_cents to 1

2016-02-16

Changed

• pagination: introduced a limit for the per_page parameter

2016-02-12

Removed some deprecated attributes

• Removed donated_amount_in_cents from client endpoint
• Removed pool_balance_in_cents from client endpoint
• Removed open_amount_in_cents from client endpoint
• Removed requested_amount_in_cents from client endpoint
• Removed projects_count from client endpoint
• Removed client_donated_amount_in_cents from client endpoint
• Removed client_matched_amount_in_cents from client endpoint
• Removed client_donations_count from client endpoint

2016-01-12

Removed

• Removed open_amount_in_cents from client statistics
• Removed pool_balance_in_cents from client statistics
• Removed client_matched_amount_in_cents from client statistics

Changed

• donated_amount_in_cents does no longer include external donations client statistics
• client_donated_amount_in_cents now includes matching fund forwardings client statistics
• client_donated_amount_in_cents doesn't include pool donations any more client statistics
• donation pledges: introduced validate_address option

Added

• Client Details: client specific endpoint for volunteering offers

2015-10-09

Added

• Improved documentation for donation pledges

2015-09-15

Added

• Added facet filter closed:true/false projects list.

2015-08-28

Added

• Added closed_at datetime to project details.
• Extended documentation for created_at and completed_at in project details.

2015-07-30

Fixed

• Documentation wording for donor opinions facets=has_donation:true/false and donated_amount_in_cents. The documentation is more detailed now and also includes two know issues where donor opinions do not behave as expected.

2015-06-17

Deprecated

• The url params for the ThirdPartyApp custom donation form changed:
• donation_presenter[some_value]=123 is deprecated now. Please update your app until 12/2015.
• some_value=123 is the new way as described in the documentation.

2015-04-28

Added

• Added API endpoint for clients to query donor data if permission was granted. See details at Client Donor Contact Data

2015-04-07

Added

• Added two API endpoints for client statistics. 0. Client Project Statistics 0. Client Fundraising Event Statistics

Deprecated

• Client Details: All statistic values. This end point will be removed after 31.5.2015

2015-03-05

Added

• Added API endpoints for fundraising events and linked to them from all relevant resources. This includes related features for clients as well. See here and here.

Deprecated

• Fundraising Events Details
  • profile_picture: fill_618x322, fill_270x141
• Fundraising Events List
  • profile_picture: fill_618x322, fill_270x141
• Matching Fund Projects List
  • profile_picture: fill_618x322, fill_270x141
• Project Details
  • profile_picture: fill_618x322, fill_270x141
• Projects List
  • profile_picture: fill_618x322, fill_270x141
• Volunteering Details
  • profile_picture: fill_618x322, fill_270x141
  • image: fill_618x322, fill_270x141, original, thumb, medium, regular
• Volunteering List
  • profile_picture: fill_618x322, fill_270x141
  • image: fill_618x322, fill_270x141, original, thumb, medium, regular

2015-02-16

Added

• Added client API endpoint for submit donation pledges to. See here
• Added client API endpoint to subscribe to project newsletters. See here.

Deprecated

• Authentication via api_token parameter and Api-Token header is deprecated in favor of using basic authentication.

Fixed

• Reworked order and hierarchy in readme.

2015-01-15

Added

• Added the around parameter for project and volunteering listings, that sorts by distance to its value.

2014-11-18

Added

• Fallback flag for profile pictures to indicate whether the given picture is a default picture or was uploaded by the user

2014-09-05

Added

• Clarify the order behaviour for fundraising challenge results.

2014-08-14

Added

• This CHANGELOG, following the ideas of http://keepachangelog.com/
• Refactor the previous changelog to follow this convention.
• Update todo-note in table of content
• Add two more websites to "Example Integrations" for ThidPartyApp Donation Form

Removed

• Previous Changelog in README

2014-08-11

Added

• Add Fundraising Challenge to API and Documentation

2014-01 - 2014-04

This is the aggrgated changelog for all changes for this time interval.

Added

• 2013-06-20: Add client.pool_balance_in_cents property, see doc for details
• 2013-06-14: Add platform-link to blog_posts-details
• 2013-05-15: Opinions have a link to the project now. All API-link are "api.betterplace.org" now (not www. anymore). Opinions have have a facets=has_message-Feature now.
• 2013-04-19: Change the naming of api-docu-files to follow rails-pluralization-convention.
• 2013-04-19: Added 'client project-tag list' (a list of all project-tags for a client) and 'client project-tag projects list' (a list of all projects for a client-project-tag).
• 2013-04-17: Add project pictures API. Please note the DEPRECATION warning for the project- and volunteering-profilepicture (sizes large, profile and thumb are deprecated and therefore renamed.)

Removed

• 2014-03-04: Remove all deprecated picture links from responses.
• 2014-01-26: Remove the beta-flag; add matching-fund api; add code and usage examples; minor improvements

Fixed

• 2013-04-18: Fixed project opinions. Add client opinions-feature. Note that many of the opinions-facets changed! Please re-read this part of the documentation.

2014-01 - 2014-04

This is the aggrgated changelog for all changes for this time interval.

Added

• 2012-04-15: Add "Client Project-Tag Project List".
• 2012-03-03: Add picture size 'large' and 'original' to image list for projects. Please note that the images-part of the API ist still beta and might change slightly in the future.
• 2012-03-28: The project-list now returns the full result-set for each project. The minimal result set is gone for now but will be added later. The default-number of results changed to 20 for all lists.
• 2012-05~15: Add known issues, improve documentation, add opinion.donated_amount_in_cents, project.description returns html now
• 2012-03-13: Update TOC, fix opinions-details and -list response, fix empty documentation (@tordans)
• 2012-03-12: Several updates to readme, updates to descriptions for clients, updated opinions-docu, added know-issues and changelog sections (@tordans)

Removed

• 2012-05~15: Removed opinion.with_donation

2012-03-11

Added

• Initial version (@betterplace)

---

Template

201x-0x-xx

Added

• Nothing.

Deprecated

• Nothing.

Removed

• Nothing.

Fixed

• Nothing.