Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
flori committed Aug 18, 2017
1 parent 555bf45 commit 8f601c38555fded23db87f9d4a072b03b3d84954
Showing with 1,674 additions and 378 deletions.
  1. +22 −0 CHANGELOG.md
  2. +0 −1 README.md
  3. +6 −5 donation_form/third_party_app_donation_form.md
  4. +3 −0 sections/blog_post_details.md
  5. +105 −3 sections/blog_posts_list.md
  6. +0 −17 sections/client_details.md
  7. +1 −0 sections/client_donation_details.md
  8. +1 −0 sections/client_donation_pledge_details.md
  9. +18 −1 sections/client_donation_pledges_list.md
  10. +29 −28 sections/client_donations_list.md
  11. +3 −2 sections/client_forwarding_request_details.md
  12. +18 −1 sections/client_forwarding_requests_list.md
  13. +1 −0 sections/client_fundraising_event_statistics.md
  14. +1 −0 sections/client_mailing_subscriptions.md
  15. +1 −0 sections/client_project_statistics.md
  16. +4 −3 sections/client_project_tags_list.md
  17. +3 −2 sections/client_tags_list.md
  18. +1 −0 sections/contact_data_details.md
  19. +1 −0 sections/donor_contact_data_details.md
  20. +13 −9 sections/fundraising_event_details.md
  21. +1 −0 sections/fundraising_event_forwardings_list.md
  22. +135 −19 sections/fundraising_events_featured_projects_list.md
  23. +300 −3 sections/fundraising_events_list.md
  24. +3 −2 sections/matching_fund_details.md
  25. +2 −1 sections/matching_funds_list.md
  26. +13 −12 sections/need_details.md
  27. +31 −30 sections/needs_list.md
  28. +40 −57 sections/opinions_list.md
  29. +11 −7 sections/organisation_details.md
  30. +18 −14 sections/organisations_list.md
  31. +2 −1 sections/pool_details.md
  32. +135 −19 sections/project_details.md
  33. +6 −5 sections/project_picture_details.md
  34. +15 −14 sections/project_pictures_list.md
  35. +571 −4 sections/projects_list.md
  36. +92 −59 sections/volunteering_details.md
  37. +1 −0 sections/volunteering_inquiries.md
  38. +67 −59 sections/volunteering_list.md
View
@@ -3,6 +3,28 @@ 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).
## 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).
## 2017-07-20
### Added
- Added `summary` to [project details](sections/project_details.md).
## 2017-06-16
### Added
- Added `donations_count` integer to [project details](sections/project_details.md).
- Added `comments_count` integer to [project details](sections/project_details.md).
### Removed
- Removed [endpoint](sections/opinions_list.md) for clients
### Changed
- Deprecated `positive_opinions_count` and `negative_opinions_count` on [project](sections/project_details.md) as well as `positive_or_negative` on [opinion](sections/opinion_list.md)
## 2017-03-03
### Removed
- Removed [Fundraising Challenge] endpoint
View
@@ -90,7 +90,6 @@ about updates and scheduled downtimes.
1. [**Client** Project Details](sections/project_details.md) – 
See client section [and "Client Projects"](#client-api)
1. [**Client** Blog Posts List](sections/blog_posts_list.md) – See client section
1. [**Client** Project Opinions List](sections/opinions_list.md) – See client section
1. [**Client** Mailing Subscribtions](sections/client_mailing_subscriptions.md) [:lock:](#client-api)
1. **Tags**
1. [**Client** Tags List](sections/client_tags_list.md)
@@ -15,10 +15,12 @@ This feature is distinct from our [json-API v4](https://github.com/betterplace/b
### Example Integrations
* [Ablass App](http://www.ablass-app.de/), where you can clean your conscience
* [MADAide](http://madaide.org/?page_id=578), where you can donate to mark a specific piece of the football field with your name
* _(Closed)_ [Donatify me](http://donatify.me/), where you can get Edward to do stuff for you
* _(Closed)_ [Seeds of Kindness 3](http://yoursiblings.org/portico/seeds-of-kindness-3), where you get a mp3 download link after your donation. Also there is a leader board and referrer-system
* [Ablass App](http://www.ablass-app.de/), where you can clean your conscience.
* [Tramprennen](https://tramprennen.org/) and [Floßrennen](http://flossrennen.tramprennen.org/) ([GitHub](https://github.com/Club-of-Roam/cor-mgmt)) is a race where you can support one of the teams.
* [MADAide](http://madaide.org/?page_id=578), where you can donate to mark a specific piece of the football field with your name.
* [Tierheim Berlin](http://www.tierheim-geschenke.de/), where you can view and donate to specific needs of the project.
* _(Closed)_ [Donatify me](http://donatify.me/), where you can get Edward to do stuff for you.
* _(Closed)_ [Seeds of Kindness 3](http://yoursiblings.org/portico/seeds-of-kindness-3), where you get a mp3 download link after your donation. Also there is a leader board and referrer-system.
### UserFlow
@@ -266,4 +268,3 @@ The core for this ThirdPartyApp donation form is the technology that runs our cl
## Feedback
Please send us feedback at product@betterplace.org
@@ -50,6 +50,7 @@ Blogpost id as an integer number ≥ 9.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -151,6 +152,7 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
<tr>
<th>Attribute</th>
@@ -200,6 +202,7 @@ User profile picture or a fallback image
</table>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
<table>
<tr>
<th>Attribute</th>
View
@@ -44,6 +44,7 @@ Project id as an integer number ≥ 14.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -145,6 +146,7 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
<tr>
<th>Attribute</th>
@@ -194,6 +196,7 @@ User profile picture or a fallback image
</table>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
<table>
<tr>
<th>Attribute</th>
@@ -321,13 +324,112 @@ Maximum sized image. This is the original image with default-cropping or user-cr
```json
{
"total_entries": 0,
"total_entries": 92,
"offset": 0,
"total_pages": 0,
"total_pages": 46,
"current_page": 1,
"per_page": 2,
"data": [
{
"id": 5029,
"created_at": "2009-05-21T10:50:46+02:00",
"updated_at": "2014-02-26T15:27:11+01:00",
"lang": "de",
"type": "BlogPost",
"title": "Skateistan-Trailer",
"body": "<p><a href=\"http://youtube.com/watch?v=i6W6_G-h6is\">http://youtube.com/watch?v=i6W6_G-h6is</a></p>",
"author": {
"id": 9238,
"name": "M. Henninger",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/009/238/fill_100x100_original_maxn_skate.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/009/238/crop_original_original_maxn_skate.jpg"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/9238"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/9238/contact_data.json"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/blog_posts/5029.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/projects/1114-skateistan-afghanistan/news/5029"
},
{
"rel": "documentation",
"href": "https://github.com/betterplace/betterplace_apidocs/blob/master/sections/blog_post_details.md"
}
]
},
{
"id": 5168,
"created_at": "2009-05-28T14:21:08+02:00",
"updated_at": "2009-05-28T14:22:21+02:00",
"lang": "de",
"type": "BlogPost",
"title": "Brieffreunde gesucht",
"body": "Kreisjugendring Würzburg will Brieffreundschaften mit Skateistan ins Leben rufen!<br><br><br>Eine Welt abseits von Krieg und Armut soll das Projekt „Skateistan“ für Kinder und Jugendliche in Kabul sein. Der Deutsch-Australier Oliver Percovich leistet hier Entwicklungshilfe der besonderen Art. <br> <br>Durch einen Bericht in der Main-Post wurde der Kreisjugendring Würzburg auf die Organisation aufmerksam. <br><br>Carsten Hackel, Vorstand des Kreisjugendringes, war so begeistert von der Idee, dass er direkt eine Hilfsaktion startete. Neben einer großen Skateboard-Sammelaktion entstand auch die Idee, Brieffreundschaften zwischen deutschen und afghanischen Kindern ins Leben zu rufen.<br><br>Für viele Kinder bedeutet „Skateistan“ zumindest einen Teil ihres Alltags in einem normalen Umfeld zu verbringen. Da kann der Kontakt zu Kindern in Deutschland einen schönen Beitrag leisten. „Für unsere Kinder dagegen ist ein solches Projekt die Gelegenheit Vorurteile und Wissensdefizite abzubauen“, begründet Hackel das Engagement des Kreisjugendrings. <br><br>Die Schirmherrschaft hat Kreistagsabgeordnete Elisabeth Schäfer übernommen. <br><br>Da das Verschicken von Post nach Afghanistan kompliziert ist, würde der Kreisjugendring die Briefe (möglichst in Englisch verfasst) sammeln und den Versand abwickeln. Gesucht werden Jugendgruppen, Klassen, Vereine aus dem Landkreis.<br>Kontakt: Kreisjugendring Würzburg, Wittelsbacher Str. 1, 97074 Würzburg, Tel. (09 31) 8 78 99, Mail: info@kjr-wuerzburg.de; Infos zu Skateistan:",
"author": {
"id": 11872,
"name": "j. wardag",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/011/872/fill_100x100_original_jana.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/011/872/crop_original_original_jana.jpg"
}
]
},
"links": [
{
"rel": "platform",
"href": "https://www.betterplace.org/de/users/11872"
},
{
"rel": "contact_data",
"href": "https://api.betterplace.org/de/api_v4/users/11872/contact_data.json"
}
]
},
"links": [
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/blog_posts/5168.json"
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/projects/1114-skateistan-afghanistan/news/5168"
},
{
"rel": "documentation",
"href": "https://github.com/betterplace/betterplace_apidocs/blob/master/sections/blog_post_details.md"
}
]
}
]
}
```
View
@@ -104,19 +104,6 @@ client_fundraising_events
Link to the <a href="fundraising_events_list.md">fundraising events list</a> of this client
</td>
</tr>
<tr>
<th align="left">
opinions
</th>
<td>
Link to the <a href="opinions_list.md">opinions list</a> of this client
</td>
</tr>
<tr>
@@ -187,10 +174,6 @@ Link to the <a href="fundraising_event_statistics_list.md">fundraising event sta
"rel": "client_fundraising_events",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/fundraising_events.json"
},
{
"rel": "opinions",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/opinions.json"
},
{
"rel": "project_mailing_subscriptions",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/projects/%7Bproject_id%7D/mailing_subscriptions.json",
@@ -49,6 +49,7 @@ The betterplace.org-internal client permalink.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -65,6 +65,7 @@ Donation Pledge id as an integer number.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -149,6 +149,7 @@ are optional.
"email": "mm@example.com",
"amount_in_cents": 100,
"client_reference": "djksbf23u4sjkdn234p",
"tracking_via": "campaign-0815",
"earmark": 123,
"street": "Rheinstrasse 202",
"city": "Wiesbaden",
@@ -239,6 +240,21 @@ However the pledge will <em>not be processed</em> into a donation but ignored.
This is to make sure that one transaction is only processed once.
</td>
</tr>
<tr>
<th align="left">tracking_via</th>
<td><code>campaign-0815</code></td>
<td><code>string</code></td>
<td>no</td>
<td>
A tracking identifier for the current campaign, origin or similar
information. Default is blank.
<br>
Allowed characters are <code>a-zA-Z0-9_-</code>.
</td>
</tr>
<tr>
@@ -319,7 +335,7 @@ This field is mandatory by default, but optional with validate_address=false.
<th align="left">validate_address</th>
<td><code>false</code></td>
<td><code>boolean</code></td>
<td>no</td>
<td>yes</td>
<td>
Pass <code>false</code> to allow donations without a donor address.
@@ -341,6 +357,7 @@ True by default.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
Oops, something went wrong.

0 comments on commit 8f601c3

Please sign in to comment.