Skip to content
Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
xijo committed Feb 28, 2019
1 parent f67a782 commit 8bbd19fee5e96f0f5e2159f2e212b7ca7af6f83e
@@ -3,6 +3,10 @@ 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-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`

## 2019-01-28
### Added
- Added `donation_count` to [fundraising events details](sections/fundraising_events_details.md)
@@ -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-skateistan-afghanistan/news/88972"
"href": "https://www.betterplace.org/de/projects/1114-unterstutze-skateistan-sport-bildung-fur-kinder/news/88972"
},
{
"rel": "documentation",
@@ -216,7 +216,7 @@ Link to the donor contact data
{
"amount_in_cents": 1000,
"state": "confirmed",
"token": "ef7d399d07ef980cefee",
"token": "b6f3c523cb4de3cce351",
"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/ef7d399d07ef980cefee.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/b6f3c523cb4de3cce351.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ef7d399d07ef980cefee/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/b6f3c523cb4de3cce351/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/1a33fec6fc35697c13ed.json"
"href": "https://api.betterplace.org/de/api_v4/clients/natehelps/client_donations/e9e1f7ac57c9b5b01e4b.json"
}
]
}
@@ -175,39 +175,50 @@ are optional.
<td><code>Max</code></td>
<td><code>string</code></td>
<td>
yes
see description
</td>
<td>

First name of the donor.

This field is required by default, but optional with
validate_address=false.


</td>
</tr>
<tr>
<th align="left">last_name</th>
<td><code>Mustermann</code></td>
<td><code>string</code></td>
<td>
yes
see description
</td>
<td>

Last name of the donor.

This field is required by default, but optional with
validate_address=false.


</td>
</tr>
<tr>
<th align="left">email</th>
<td><code>mm@example.com</code></td>
<td><code>string</code></td>
<td>
yes
see description
</td>
<td>

Email address of the donor.
Only valid email addresses will be accepted.

This field is required by default, but optional with
validate_address=false.


</td>
</tr>
@@ -226,16 +226,16 @@ Link to the donor contact data

```json
{
"total_entries": 18349,
"total_entries": 19041,
"offset": 0,
"total_pages": 6117,
"total_pages": 6347,
"current_page": 1,
"per_page": 3,
"data": [
{
"amount_in_cents": 200,
"state": "confirmed",
"token": "ac52225fc20638b83313",
"token": "28fb1fbb286e89f36275",
"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/ac52225fc20638b83313.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/28fb1fbb286e89f36275.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/ac52225fc20638b83313/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/28fb1fbb286e89f36275/donor_contact_data.json"
}
]
},
{
"amount_in_cents": 100,
"state": "confirmed",
"token": "eed65f27b8fc3a2619d2",
"token": "8ecc349bf785ad2a9a8d",
"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/eed65f27b8fc3a2619d2.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/8ecc349bf785ad2a9a8d.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/eed65f27b8fc3a2619d2/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/8ecc349bf785ad2a9a8d/donor_contact_data.json"
}
]
},
{
"amount_in_cents": 1000,
"state": "confirmed",
"token": "48c2c33cbe5557e0939f",
"token": "f6b71080ef426b3f2fc1",
"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/48c2c33cbe5557e0939f.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/f6b71080ef426b3f2fc1.json"
},
{
"rel": "donor_contact_data",
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/48c2c33cbe5557e0939f/donor_contact_data.json"
"href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations/f6b71080ef426b3f2fc1/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/b7c8b47116fa09e896cb.json"
"href": "https://api.betterplace.org/de/api_v4/clients/particulate-sww/client_donations/332fa2f3a8f65fa92560.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": 33,
"projects_count": 30,
"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": 50,
"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": 12,
"projects_count": 14,
"links": [
{
"rel": "projects",
@@ -119,7 +119,7 @@ Link to the <a href="client_tag_projects_list.md">client-tag projects list</a>
{
"tag": "Bedürftige",
"slug": "Bedürftige",
"projects_count": 12,
"projects_count": 15,
"links": [
{
"rel": "projects",
@@ -96,8 +96,8 @@ The email address of the user or donor.

```json
{
"first_name": "Adriano",
"last_name": "Köhler",
"first_name": "Linus",
"last_name": "Voss",
"email": "mjo@betterplace.org",
"links": [
@@ -618,7 +618,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
{
"id": 19267,
"created_at": "2014-09-23T21:17:06+02:00",
"updated_at": "2018-02-07T03:07:50+01:00",
"updated_at": "2019-02-19T00:25:11+01:00",
"content_updated_at": "2015-06-28T11:32:11+02:00",
"title": "Gemeinsam gegen Ebola: Deine Spende für Westafrika",
"description": "Das Ebola-Virus ist für uns* in Westafrika allgegenwärtig: Schüttelt man zur Begrüßung noch die Hand, obwohl die Regierungen davon abraten? Tritt man die Dienstreise in das vom Virus betroffene Nigeria an? Droht die Quarantäne, wenn man bei der Ausreise aus der Region unter Erkältung und Fieber leidet? <br><br>Für die Menschen in Sierra Leone, Liberia und Guinea sind das Luxusprobleme. Dort ist ein normaler Alltag nicht mehr möglich. Im Familienkreis oder der Nachbarschaft gibt es möglicherweise Tote zu beklagen. Der Zugang zu Gesundheitsdienstleistungen ist, auch für andere häufig auftretende Krankheiten wie Malaria, erschwert und kann teilweise nicht mehr gewährleistet werden. <br><br>Viele Ärzte und Krankenschwestern sind selbst gestorben oder haben Angst, sich selbst anzustecken, da es an grundsätzlichen Dingen wie Schutzkleidung und Arzneimitteln fehlt. Unsere Spenden unterstützen Action Medeor beider Ausrüstung zweier neu aufgebauter Isolierstationen in Monrovia, Liberia.<br><br>Die internationale Gemeinschaft reagiert nur sehr langsam – obwohl das Virus bereits seit Anfang des Jahres mehr als 2500 Menschen den Tod gekostet hat. Die langfristigen Folgen für die Volkswirtschaften, die Gesundheitssysteme und das Zusammenleben der Menschen in der Region sind verheerend. <br><br>Wir müssen jetzt handeln, um den Menschen vor Ort und ihren Helfern die notwendigen Materialien zukommen zu lassen. Wir denken dabei auch an unsere Freunde hier in der Region, die wir auf Dienstreisen kennen gelernt haben oder die als Ärzte in Alarmbereitschaft versetzt wurden. Helft uns dabei, den Menschen in ihrer Notlage zu helfen: Teilt diesen Link mit anderen und spendet, auch kleine Beiträge sind willkommen! <br><br>* Jonas lebt seit mehr als zwei Jahren im Senegal, Johanna war für knapp zwei Monate im benachbarten Gambia. Wir beide haben in den letzten Wochen die Nachrichtenlage verfolgt und mit den Menschen vor Ort über die Unsicherheit gesprochen. <br><br>Bild: Jonas Wipfler, Liberia, 2013",
@@ -633,7 +633,7 @@ Maximum sized image. This is the original image with default-cropping or user-cr
"progress_percentage": null,
"contact": {
"id": 397832,
"name": "Raul E.",
"name": "Selina Y.",
"picture": {
"links": [
{

0 comments on commit 8bbd19f

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