Skip to content
Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information
flori committed Jan 28, 2020
1 parent e4faab1 commit 4690d636b03ef5f51ca18e75f777bd9a94bc4d2a
@@ -3,6 +3,11 @@ 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).


## 2020-01-27
### Removed
- Listing of illustrations

## 2019-02-25
### Changed
- Changed behavior of `validate_address` of [donation pledges](sections/client_donation_pledges.md): `first_name`, `last_name` and `email` won't be validated if set to `false`
@@ -67,7 +67,7 @@ about updates and scheduled downtimes.
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)
1. [**Illustrations** List](deprecated)

### **Client API**

@@ -345,7 +345,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/88972"
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/88972#ppp-sticky-anchor"
},
{
"rel": "documentation",
@@ -350,16 +350,16 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"body": "<p><br></p><p>Approximately one year ago, a young German hairstyling student read a piece about Skateistan. When she found herself working as a nurse in the German military hospital in Mazar-e-Sharif soon after, the skateboarding students of Kabul lingered in her mind. The soldier, Alexandra H., decided to use her skills to support Skateistan in any way she could — so she began to collect donations by giving haircuts to German soldiers serving in Afghanistan.</p><br><p>News of Alexandra’s “haircuts for a good cause” spread rapidly at Mazar-e-Sharif’s Camp Marmal. Before long, she had given 150 haircuts: at the end of June 2009, she generously handed all of the profits to Skateistan.</p><br><p>Alexandra, who has promised to continue her fundraising efforts for Skateistan when she returns to Germany, has quickly become one of the organization’s most innovative and committed supporters.</p><br>",
"author": {
"id": 9238,
"name": "Edwin Hentschel",
"name": "Mira Dietrich",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/009/238/fill_100x100_original_maxn_skate.jpg"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/009/238/fill_100x100_bp1576596032_original_maxn_skate.jpg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/009/238/crop_original_original_maxn_skate.jpg"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/009/238/crop_original_bp1576596032_original_maxn_skate.jpg"
}
]
},
@@ -381,7 +381,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/7019"
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/7019#ppp-sticky-anchor"
},
{
"rel": "documentation",
@@ -405,7 +405,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
},
{
"rel": "platform",
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/8076"
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/8076#ppp-sticky-anchor"
},
{
"rel": "documentation",
@@ -216,7 +216,7 @@ Link to the donor contact data
{
"amount_in_cents": 1000,
"state": "confirmed",
"token": "cb88e81a12bae9e155f9",
"token": "ea0d070a281c8aa9b3d9",
"client_reference": null,
"created_at": "2010-10-28T14:44:49+02:00",
"receiver_type": "Project",
@@ -229,11 +229,11 @@ Link to the donor contact data
},
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/cb88e81a12bae9e155f9.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ea0d070a281c8aa9b3d9.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/cb88e81a12bae9e155f9/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ea0d070a281c8aa9b3d9/donor_contact_data.json"
}
]
}
@@ -226,7 +226,7 @@ Link to the related donation
"links": [
{
"rel": "donation",
"href": "https://api.betterplace.org/de/api_v4/clients/natehelps/client_donations/deff4fd1a8558b1c5980.json"
"href": "https://api.betterplace.org/de/api_v4/clients/natehelps/client_donations/91836b71b8317c27f30a.json"
}
]
}
@@ -226,16 +226,16 @@ Link to the donor contact data

```json
{
"total_entries": 19526,
"total_entries": 19635,
"offset": 0,
"total_pages": 6509,
"total_pages": 6545,
"current_page": 1,
"per_page": 3,
"data": [
{
"amount_in_cents": 200,
"state": "confirmed",
"token": "31ace855f1582a64979f",
"token": "24c3c7d7fcdb180954b0",
"client_reference": null,
"created_at": "2011-12-13T13:48:15+01:00",
"receiver_type": "FundraisingEvent",
@@ -248,18 +248,18 @@ Link to the donor contact data
},
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/31ace855f1582a64979f.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/24c3c7d7fcdb180954b0.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/31ace855f1582a64979f/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/24c3c7d7fcdb180954b0/donor_contact_data.json"
}
]
},
{
"amount_in_cents": 100,
"state": "confirmed",
"token": "2d80baa2216f47cf5402",
"token": "4796815fe4f80e63cd87",
"client_reference": null,
"created_at": "2012-05-23T16:41:06+02:00",
"receiver_type": "FundraisingEvent",
@@ -272,18 +272,18 @@ Link to the donor contact data
},
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/2d80baa2216f47cf5402.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/4796815fe4f80e63cd87.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/2d80baa2216f47cf5402/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/4796815fe4f80e63cd87/donor_contact_data.json"
}
]
},
{
"amount_in_cents": 1000,
"state": "confirmed",
"token": "13e357c054129a6a9486",
"token": "a4b0e6cf3fa862cdcef6",
"client_reference": null,
"created_at": "2012-06-12T16:53:03+02:00",
"receiver_type": "FundraisingEvent",
@@ -296,11 +296,11 @@ Link to the donor contact data
},
{
"rel": "self",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/13e357c054129a6a9486.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/a4b0e6cf3fa862cdcef6.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/13e357c054129a6a9486/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/a4b0e6cf3fa862cdcef6/donor_contact_data.json"
}
]
}
@@ -221,7 +221,7 @@ Link to the related donation
"links": [
{
"rel": "donation",
"href": "https://api.betterplace.org/de/api_v4/clients/particulate-sww/client_donations/fae16bfa027a7a1fa259.json"
"href": "https://api.betterplace.org/de/api_v4/clients/particulate-sww/client_donations/17312286702d7efea594.json"
}
]
}
@@ -158,7 +158,7 @@ Link to the <a href="client_tag_projects_list.md">client-tag projects list</a>
{
"tag": "Trier",
"slug": "Trier",
"projects_count": 27,
"projects_count": 28,
"links": [
{
"rel": "projects",
@@ -169,7 +169,7 @@ Link to the <a href="client_tag_projects_list.md">client-tag projects list</a>
{
"tag": "KinderJugendliche",
"slug": "KinderJugendliche",
"projects_count": 36,
"projects_count": 37,
"links": [
{
"rel": "projects",
@@ -180,7 +180,7 @@ Link to the <a href="client_tag_projects_list.md">client-tag projects list</a>
{
"tag": "Familien",
"slug": "Familien",
"projects_count": 14,
"projects_count": 15,
"links": [
{
"rel": "projects",
@@ -130,7 +130,7 @@ Link to the <a href="client_tag_projects_list.md">client-tag projects list</a>
{
"tag": "Inklusion",
"slug": "Behinderte",
"projects_count": 14,
"projects_count": 13,
"links": [
{
"rel": "projects",
@@ -96,8 +96,8 @@ The email address of the user or donor.

```json
{
"first_name": "李伟",
"last_name": "Robinson",
"first_name": "Mia",
"last_name": "Hentschel",
"email": "mjo@betterplace.org",
"links": [
@@ -633,16 +633,16 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"progress_percentage": null,
"contact": {
"id": 397832,
"name": "Moritz Krüger",
"name": "Shirin Schreiber",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/fill_100x100_JoJo.jpg"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/fill_100x100_bp1576616546_JoJo.jpg"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/crop_original_JoJo.jpg"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/397/832/crop_original_bp1576616546_JoJo.jpg"
}
]
},
@@ -1217,10 +1217,10 @@ information for the donors.
{
"id": 1114,
"created_at": "2009-03-10T11:12:16+01:00",
"updated_at": "2019-12-04T00:01:22+01:00",
"updated_at": "2020-01-13T00:01:20+01:00",
"latitude": 34.5553494,
"longitude": 69.207486,
"street": "Talstraße 40",
"street": "Tulpenstraße 125",
"zip": "",
"city": "Afghanistan, Cambodia",
"country": "Südafrika",
@@ -1233,30 +1233,30 @@ information for the donors.
"donations_prohibited": false,
"completed_at": null,
"closed_at": null,
"open_amount_in_cents": 1049939,
"donated_amount_in_cents": 6524913,
"positive_opinions_count": 909,
"open_amount_in_cents": 738439,
"donated_amount_in_cents": 6886413,
"positive_opinions_count": 944,
"negative_opinions_count": 0,
"donations_count": 909,
"newsletter_subscriptions_count": 345,
"donations_count": 944,
"newsletter_subscriptions_count": 368,
"comments_count": 0,
"donor_count": 659,
"progress_percentage": 86,
"incomplete_need_count": 5,
"completed_need_count": 96,
"donor_count": 684,
"progress_percentage": 90,
"incomplete_need_count": 3,
"completed_need_count": 99,
"blog_post_count": 95,
"contact": {
"id": 287126,
"name": "Katharina Pfeffer",
"name": "Alica Born",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/287/126/fill_100x100_bp1523439147_Skateistan_facebook-02.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/287/126/fill_100x100_bp1576607865_Skateistan_facebook-02.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/287/126/crop_original_bp1523439147_Skateistan_facebook-02.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/287/126/crop_original_bp1576607865_Skateistan_facebook-02.png"
}
]
},
@@ -1350,7 +1350,7 @@ information for the donors.
},
{
"rel": "video",
"href": "https://www.youtube.com/watch?v=nl79wvm3s_g"
"href": "https://www.youtube.com/watch?v=49ilNgE5jO4&feature=youtu.be"
},
{
"rel": "matching_funds",
@@ -723,16 +723,16 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"progress_percentage": 9260,
"contact": {
"id": 6,
"name": "Selina Vogt",
"name": "Ezekiel Thomas",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/fill_100x100_original_eckert.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/fill_100x100_bp1576594541_original_eckert.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/crop_original_original_eckert.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/crop_original_bp1576594541_original_eckert.png"
}
]
},
@@ -833,7 +833,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"progress_percentage": null,
"contact": {
"id": 152691,
"name": "Maria Kühn",
"name": "Miko Gottschalk",
"picture": {
"fallback": true,
"links": [
@@ -945,16 +945,16 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"progress_percentage": null,
"contact": {
"id": 6,
"name": "Selina Vogt",
"name": "Ezekiel Thomas",
"picture": {
"links": [
{
"rel": "fill_100x100",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/fill_100x100_original_eckert.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/fill_100x100_bp1576594541_original_eckert.png"
},
{
"rel": "original",
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/crop_original_original_eckert.png"
"href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/000/006/crop_original_bp1576594541_original_eckert.png"
}
]
},

0 comments on commit 4690d63

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