Skip to content
Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
xijo committed Feb 14, 2019
1 parent 2f7f4ed commit f67a78279e2e467eeced588b3f8a2e7911ca7639
Showing with 1,077 additions and 1,105 deletions.
  1. +13 −0 CHANGELOG.md
  2. +5 −3 README.md
  3. +1 −1 donation_form/third_party_app_donation_form.md
  4. BIN images/betterplace.jpg
  5. +58 −0 images/betterplace.svg
  6. +1 −1 sections/blog_post_details.md
  7. +15 −5 sections/blog_posts_list.md
  8. +1 −1 sections/client_details.md
  9. +12 −12 sections/client_donation_details.md
  10. +3 −3 sections/client_donation_pledge_status.md
  11. +46 −17 sections/client_donation_pledges_creation.md
  12. +12 −12 sections/client_donations_list.md
  13. +13 −10 sections/client_forwarding_request_details.md
  14. +10 −4 sections/client_forwarding_requests_list.md
  15. +1 −1 sections/client_fundraising_event_statistics.md
  16. +13 −5 sections/client_mailing_subscriptions.md
  17. +1 −1 sections/client_project_statistics.md
  18. +17 −2 sections/client_project_tags_list.md
  19. +16 −2 sections/client_tags_list.md
  20. +3 −3 sections/contact_data_details.md
  21. +1 −1 sections/donor_contact_data_details.md
  22. +89 −3 sections/fundraising_event_details.md
  23. +59 −6 sections/fundraising_event_forwardings_list.md
  24. +28 −28 sections/fundraising_events_featured_projects_list.md
  25. +113 −217 sections/fundraising_events_list.md
  26. +239 −0 sections/illustrations_list.md
  27. +1 −1 sections/matching_fund_details.md
  28. +2 −2 sections/matching_funds_list.md
  29. +6 −6 sections/need_details.md
  30. +31 −31 sections/needs_list.md
  31. +5 −3 sections/opinions_list.md
  32. +9 −9 sections/organisation_details.md
  33. +12 −12 sections/organisations_list.md
  34. +4 −4 sections/pool_details.md
  35. +28 −28 sections/project_details.md
  36. +6 −6 sections/project_picture_details.md
  37. +18 −18 sections/project_pictures_list.md
  38. +5 −454 sections/projects_list.md
  39. +60 −87 sections/volunteering_details.md
  40. +25 −9 sections/volunteering_inquiries.md
  41. +95 −97 sections/volunteering_list.md
@@ -3,6 +3,19 @@ All notable changes to the betterplace.org API v4 will be documented in this
file. Notifications about changes will also be send to the [mailing list for
service announcements](README.md#mailing-list-for-service-announcements).

## 2019-01-28
### Added
- Added `donation_count` to [fundraising events details](sections/fundraising_events_details.md)
- Added `new_message` link to [fundraising events details](sections/fundraising_events_details.md)
- [Blog posts endpoint](sections/blog_posts_list.md) is now available for fundraising events as well.
- Extended [fundraising event forwarding list](sections/fundraising_event_forwardings_list.md), 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](sections/client_donation_pledges_list.md) and [forwarding requests](sections/client_forwarding_requests_list.md).
@@ -1,4 +1,4 @@
![betterplace.org](images/betterplace.jpg "betterplace.org")
<img src="images/betterplace.svg" alt="betterplace.org" width="400" />

# The betterplace.org API Version 4

@@ -23,7 +23,7 @@ about updates and scheduled downtimes.

### **General information**

1. General information [↓ below](#general-information)
1. General information [↓ below](#general-information-1)
1. Request Parameter Format [↓ below](#request-parameter-format)
1. Addressing the locale of a resource [↓ below](#addressing-the-locale-of-a-resource)
1. Pagination [↓ below](#pagination)
@@ -65,6 +65,8 @@ about updates and scheduled downtimes.
1. **MatchingFunds**
1. [**MatchingFunds** List](sections/matching_funds_list.md)
1. [**MatchingFund** Details](sections/matching_fund_details.md)
1. **Illustrations**
1. [**Illustrations** List](sections/illustrations_list.md)

### **Client API**

@@ -113,7 +115,7 @@ about updates and scheduled downtimes.
* We support [Cross-origin resource sharing (CORS)](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), so no proxy or JSONP is required
* Authentication: Most API calls are public.
Some client API features require authentication. [Learn more](#client-authentication)
* The data of betterplace Users, Companies and Portals is not part of the API at this moment.
* The data of betterplace Users is not part of the API at this moment.


### Request parameter format
@@ -36,7 +36,7 @@ This is a typical user flow when you use the ThirdPartyApp custom donation form

### Alternative solutions

Before you start considering the ThirdPartyApp custom donation form please make sure to check out the other online donation tools that betterplace.org provides. Especially the integrated donation form (iFrame). For more, please visit the [German](https://www.betterplace.org/c/hilfe/) or [English help area](https://www.betterplace.org/c/help/).
Before you start considering the ThirdPartyApp custom donation form please make sure to check out the other online donation tools that betterplace.org provides. Especially the integrated donation form (iFrame). For more, please visit the [German](https://www.betterplace.org/c/hilfe/) or [English help area](https://www.betterplace.org/c/help).



Binary file not shown.
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 2406.6 358.8" style="enable-background:new 0 0 2406.6 358.8;" xml:space="preserve">
<style type="text/css">
.st0{fill:#9ECB09;}
</style>
<g id="Bildmarke">
<path class="st0" d="M213.9,290.7c9.7-10.4,20.7-22.3,35.5-38.4c50.5-54.6,59.8-111.8,43.1-159C276.7,48.8,217.4,0,150.8,0
C82.4,0.5,22.6,46.6,7.4,93.4c-10.2,31.5-20,89.9,45.4,159.9l97.8,105.5l21-22.6c0,0-68.8-74.5-93.8-101.5
C57.6,209.8,22.6,165.4,37.1,107c5.5-22.3,45.3-76.4,113.8-76.2c68.4,0.2,105.7,56.7,111.9,73.4c14.3,38.7,6.3,82.1-38.6,130.2
c-16,17.1-7.6,8.3-23.9,25.7c0,0-66.2-71.8-83.2-90.4c-12.6-13.8-14.6-36-0.8-49.6c13.6-13.3,34.6-17.3,51.5-1.1l19.9,21.7
c10.3,10.7,14.6,10.6,24.1,0.8c7.4-7.6,24.5-26.5,28.9-31.4c-7.6-7.4-13.7-13.4-21.9-21.6c-4.9,5.2-16,17.3-18.7,20.1
c-10.7-11.5-24.2-30.5-56.5-30.8c-19.6,0-37,8.3-49,20.2c-16.4,18-19.3,33.3-19.6,41.7c-0.6,17.4,1.3,31.7,22.9,55.3
c35.3,38.2,78.5,84.7,89,95.9C197.3,301.9,203.7,301.7,213.9,290.7z"/>
</g>
<g id="Wortmarke">
<g>
<path d="M2084.9,273.4c0,10.7-8.6,19.6-19.6,19.6c-10.7,0-19.3-8.9-19.3-19.6c0-10.5,8.6-19.3,19.3-19.3
C2076.3,254.1,2084.9,263,2084.9,273.4z"/>
<path d="M2214.9,235c0,34.5-19.5,57.7-52.2,57.7c-32.5,0-52.2-21.6-52.2-57.7c0-34.7,19.5-57.7,52.4-57.7
C2195.3,177.3,2214.9,198.8,2214.9,235z M2140.9,235c0,25.1,7.4,36,21.8,36c14.4,0,21.8-11.1,21.8-36c0-25.1-7.4-36-21.6-36
C2148.3,199,2140.9,210.1,2140.9,235z"/>
<path d="M2297.6,179l-4.9,28.2c-3.3-0.8-6-1.4-9.7-1.4c-13.4,0-19.5,9.9-23.4,27.3v59.5h-29.2V180.5h25.3l2.7,21.2
c5.1-15.2,15.6-24.3,28.4-24.3C2290.6,177.4,2293.9,178,2297.6,179z"/>
<path d="M2406.6,186.5c-8,3.1-18.3,4.1-31.4,4.1c13.4,6,20.1,14.2,20.1,28c0,21.2-17.1,36.6-44.8,36.6c-4.7,0-8.8-0.4-12.7-1.4
c-2.5,1.6-4.1,4.3-4.1,7.2c0,3.7,1.8,7.2,12.5,7.2h16.6c24.7,0,40.5,13.2,40.5,31.2c0,22-19.1,35.4-55.5,35.4
c-39.9,0-50.8-13-50.8-34.7h26.1c0,10.3,4.5,14.8,25.3,14.8c20.1,0,25.5-5.5,25.5-13.4c0-7.4-5.6-11.9-17.1-11.9h-16
c-22.8,0-32.3-9.9-32.3-21.4c0-7.8,4.9-15.4,12.7-20.3c-13.6-7.4-19.3-17.1-19.3-31c0-24,19.1-39.5,46.4-39.5
c25.1,0.6,37.8-5.8,51-13.2L2406.6,186.5z M2331.2,216.3c0,12.5,7,19.9,18.1,19.9c11.7,0,17.9-7,17.9-20.3c0-13-6-19.1-18.1-19.1
C2338,196.8,2331.2,204.4,2331.2,216.3z"/>
</g>
<path d="M1498.3,30.6l-50.1,16.1v131.1h-14.4c-4.7-45.1-27.6-81.7-79.7-81.7c-29.5,0-48.5,13.1-59.7,31.7h-0.7v-27.2h-75.4
c-29.9,0-37.7,25.8-40,43.7h-0.7v-43.7h-44.4v128.6c-29.9,18.9-58.9,32.3-87.7,32.4c-31,0.1-52.6-21.3-54.9-52.2h120.9
c0-67.2-23-112.2-79.4-112.4c-59.7-0.2-89.2,45.9-89.2,101.5c0,19.6,3.6,36.6,10.4,50.8c-8.9,4.9-19.4,9.2-29.8,9.2
c-19-0.1-23.5-15.3-23.5-31.7v-89.6h31.9l22-36.6h-53.8v-69l-50,16.1v52.9h-52.8v-69l-50,16.1l-0.1,53.3h-19.8v35.9h19.9v89.2
c-31.1,20.2-61.4,34.6-91.3,34.7c-31,0.1-52.6-20.4-54.9-51.4h120.3c0-67.2-22.4-113-78.9-113.2c-52.5-0.2-81.6,35.4-87.9,81.7
h-12.7c-4.7-45.1-27.6-81.7-79.7-81.7c-26.1,0-43.7,10.8-57.5,29.1H404V30.8l-50,15.7v246.4h48.5v-23.5h0.7
c14.6,20.5,37.7,28,59,28c51.9,0,74.8-42.8,79.6-87.7h12.4c6.3,52.4,42,87.7,99.4,87.7c25.4,0,55.6-9.4,99.4-32.1
c8.9,20.1,27.6,32,55,32c14.8,0,23.5-2.7,33.3-7.3l-13.1-34.7c-2.6,1.7-5.6,2.9-9.5,3.1c-19,0.9-21.5-15.2-21.5-31.6v-89.6H850V235
c0,38.1,21.6,62.3,60.8,62.3c29.3,0,39.5-7.1,63.8-20.6c16.9,13.9,40.1,21.4,68.7,21.4c23.6,0,51.2-8,90-27.3v22h50v-70.5
c0-27.6,0-78.4,40.7-78.4c8.7,0,17.4,1.4,22,3.9v210.8h50v-87.9h0.7c17.5,21.3,35.1,26.5,56.4,26.5c55,0,77.7-40.7,81.2-87.9h14
V234c0,38.1,21.6,62.3,60.8,62.3c23.9,0,33.5-4.7,41.4-8.3c11.1,6,24.3,9.2,37.6,9.2c22.8,0,47.8-11.9,59.3-33.2h0.7
c0.4,6,0.4,18.7,2.2,28.7h44c-1.1-14.9-1.9-28.4-2.2-42.9c-0.3-10.8-0.6-27.6-0.7-40.8h12c6.3,48.5,37.6,88.1,93.6,88.2
c20.7,0,50.1-9.7,74.1-27.2c17.2,18.2,42.9,28,75.7,28c26.9,0,51.1-9.7,68-21.5V236c-22.6,19.1-39.1,25.4-65.7,25.4
c-31,0-52.6-21.3-54.9-52.2h120.9c0-67.2-23-112.2-79.4-112.4c-59.7-0.2-89.2,45.9-89.2,101.5c0,15.4,2.2,29.3,6.5,41.4
c-12.2,9.7-25.2,17.7-46.7,18.6c-35.1,1.5-51.9-27.2-51.9-62.7c0-36.2,19.8-60.7,50.8-60.8c13.9,0,17.6,1.9,27.6,7.5l15.1-31.2
c-19.3-9.6-32.7-15.1-52.9-15.1c-52.1,0-83.8,37-91.3,82.1h-12.6c-0.8-54.7-25.1-82.1-82.7-82.1c-21.3,0-47.4,5.6-66.8,14.6
l1.5,42.9c16.8-12.7,38.1-20.9,59.3-20.9c29.5,0,43.2,14.4,43.2,45.4H1618c-20.9,0-45.4-2.1-64.4,7.2c-19,9.3-32.8,26.1-32.8,54.9
c0,8.6,1.8,16.3,5.1,23c-1.4,0.4-2.8,0.6-4.2,0.6c-19,0-23.5-21.6-23.5-38L1498.3,30.6z M642.7,132.6c26.3,0,36.9,20.9,38.3,45.2
h-80.1C603,152,616.3,132.6,642.7,132.6z M448.2,258.4c-33.2,0-44-35.1-44-62.3c0-26.9,12.7-61.2,44.8-61.2
c32.5,0,41.4,35.5,41.4,61.2C490.4,222.6,481,258.4,448.2,258.4z M1032.4,133.5c26.3,0,36.9,20.1,38.3,44.3h-80.1
C992.7,152,1006,133.5,1032.4,133.5z M1340.3,258.4c-33.2,0-44-35.1-44-62.3c0-26.9,12.7-61.2,44.8-61.2
c32.5,0,41.4,35.5,41.4,61.2C1382.5,222.6,1373.2,258.4,1340.3,258.4z M1635.5,243.5c-7.8,10.5-19.8,17.2-35.1,17.2
c-17.9,0-31.7-7.1-31.7-23.5c0-28.1,32.6-28,55-28h21.6C1644.6,224.9,1641.4,235.5,1635.5,243.5z M1936.1,133.5
c26.3,0,36.8,20.1,38.2,44.3h-80.1C1896.4,152,1909.8,133.5,1936.1,133.5z"/>
</g>
</svg>
@@ -1,7 +1,7 @@

# Project Blog Post Details ⇄ [List](blog_posts_list.md)

```Rebol
```Cirru
GET https://api.betterplace.org/de/api_v4/projects/1114/blog_posts/88972.json
```

@@ -1,11 +1,11 @@

# Project Blog Posts List ⇄ [Details](blog_post_details.md)
# Blog Posts List ⇄ [Details](blog_post_details.md)

```Rebol
GET https://api.betterplace.org/de/api_v4/projects/1114/blog_posts.json
```Cirru
GET https://api.betterplace.org/de/api_v4/projects/1114/blog_posts.json?fundraising_event_id=19267
```

A list of the blog posts of a betterplace.org project.
A list of the blog posts of a betterplace.org project or fundraising event.
Results are contained in a *data* attribute.

**For [betterplace.org clients](../README.md#client-api):**
@@ -30,11 +30,21 @@ to make sure you only request data that is associated with one of your projects.
<tr>
<th align="left">project_id</th>
<td><code>1114</code></td>
<td>yes</td>
<td>no</td>
<td>

Project id as an integer number ≥ 14.

</td>
</tr>
<tr>
<th align="left">fundraising_event_id</th>
<td><code>19267</code></td>
<td>no</td>
<td>

Fundraising Event id as an integer number ≥ 1.

</td>
</tr>
</table>
@@ -1,7 +1,7 @@

# Client Details

```Rebol
```Cirru
GET https://api.betterplace.org/de/api_v4/clients/volksfreund.json
```

@@ -1,8 +1,8 @@

# Client Donation Details ⇄ [List](client_donations_list.md)

```Rebol
GET https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/V9mxWWAeuVK9PtJw9mrZRyRk.json
```Cirru
GET https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/d0d35e347873169aec71.json
```

**For [betterplace.org clients](../README.md#client-api) only:**
@@ -32,7 +32,7 @@ The betterplace.org-internal client permalink.
</tr>
<tr>
<th align="left">id</th>
<td><code>V9mxWWAeuVK9PtJw9mrZRyRk</code></td>
<td><code>d0d35e347873169aec71</code></td>
<td>yes</td>
<td>

@@ -214,26 +214,26 @@ Link to the donor contact data

```json
{
"amount_in_cents": 500,
"amount_in_cents": 1000,
"state": "confirmed",
"token": "V9mxWWAeuVK9PtJw9mrZRyRk",
"client_reference": "",
"created_at": "2014-04-15T10:26:20+02:00",
"token": "ef7d399d07ef980cefee",
"client_reference": null,
"created_at": "2010-10-28T14:44:49+02:00",
"receiver_type": "Project",
"receiver_id": 18417,
"receiver_title": "Mobiler Kinder- und Jugendtreff",
"receiver_id": 4807,
"receiver_title": "Kleinbus für den Palais e.V. Trier",
"links": [
{
"rel": "receiver",
"href": "https://api.betterplace.org/de/api_v4/projects/18417.json"
"href": "https://api.betterplace.org/de/api_v4/projects/4807.json"
},
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/V9mxWWAeuVK9PtJw9mrZRyRk.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ef7d399d07ef980cefee.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/V9mxWWAeuVK9PtJw9mrZRyRk/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ef7d399d07ef980cefee/donor_contact_data.json"
}
]
}
@@ -1,7 +1,7 @@

# Client Donation Pledges Status ⇄ [Creation](client_donation_pledges_creation.md)

```Rebol
```Cirru
GET https://api.betterplace.org/de/api_v4/clients/devk/donation_pledges/1170.json
```

@@ -163,7 +163,7 @@ part of the <code>failure_reason</code>.
This list might be extended at any time. Please
make sure you receive a notification if you encounter
a new code. Codes will note be removed but might be
depricated and not used anymore at some point in the
deprecated and not used anymore at some point in the
future.


@@ -226,7 +226,7 @@ Link to the related donation
"links": [
{
"rel": "donation",
"href": "https://api.betterplace.org/de/api_v4/clients/natehelps/client_donations/UOP8V-FJlKctLgWstNoPXnus.json"
"href": "https://api.betterplace.org/de/api_v4/clients/natehelps/client_donations/1a33fec6fc35697c13ed.json"
}
]
}

0 comments on commit f67a782

Please sign in to comment.
You can’t perform that action at this time.