Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
646 lines (523 sloc) 15.7 KB

Organisations List ⇄ Details

GET https://api.betterplace.org/de/api_v4/organisations.json

A list of betterplace.org organisations. Results are contained in a data attribute. The details and list view show the same data per organisation.

For betterplace.org clients: This resource is not available at the moment.

URL Parameters

Parameter Example Required Description

Response Attributes

Root Attributes

Attribute Types Example Description
id number 1

An integer number ≥ 1

created_at string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

updated_at string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

latitude number 52.499007

Decimal degrees based on user input

longitude number 13.44947

Decimal degrees based on user input

street null | string "Schlesische Straße 26"

Street address

zip null | string "10997"

ZIP code

city null | string "Berlin"

Name of the city

country null | string "Deutschland"

Name of the country

content_updated_at string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

slug string vivaconagua

URL slug for the permalink

name string "Viva con Agua de Sankt Pauli e.V."

Name of the organisation

description string

A description of the organisation. This may contain br tags.

tax_deductible boolean true

True if the organisation is a tax-exempt charity. If so, Users can request a tax receipt for donations to that organisation.

↓contact object

The public contact person for this organisation.

↓picture null | object

TODO

↑Nested Attributes: contact

Attribute Types Example Description
contact.id number 1

An integer number ≥ 1

contact.name null | string "Till B."

Display name of a betterplace.org user. Possible formats: "Till B.", "T. Behnke", "Till Behnke".

In the case of donation-opinions the name might also be empty/null for anonymous donations for anonymous donations.

↓contact.picture object //betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg

User profile picture or a fallback image

↑Nested Attributes: contact.picture

Attribute Types Example Description
contact.picture.fallback boolean true

Specifies whether a fallback image is given or not

↑Nested Attributes: picture

Attribute Types Example Description
picture.fallback boolean true

Specifies whether a fallback image is given or not

Response Links

Linkname Description

self

Link to this resource itself (organisation details)

platform

Permalink to betterplace.org

projects

Link to the project list of this organisation

website

Link to the website of this organisation.

contact.platform

The user's profile on betterplace.org. To view a user profile you have to be logged in. This array is empty if the user has no useraccount with betterplace.org but donated via one of our partner.

contact.contact_data

The user's contact data. Please note that you need to be authenticated as a client with matching access rights in order to see this information.

contact.picture.fill_100x100

100×100 Pixel

contact.picture.original

Maximum sized image. This is the original image with default-cropping or user-cropping applied.

picture.fill_100x100

100×100 Pixel

picture.fill_200x200

200×200 Pixel

picture.fill_400x400

400×400 Pixel

picture.original

Maximum sized image. This is the original image with default-cropping or user-cropping applied.

Response Example

{
  "total_entries": 2,
  "offset": 0,
  "total_pages": 1,
  "current_page": 1,
  "per_page": 2,
  "data": [
    {
      "id": 2262,
      "created_at": "2009-11-02T16:12:49+01:00",
      "updated_at": "2017-04-11T08:02:26+02:00",
      "latitude": 50.91569900512695,
      "longitude": 6.94116020202637,
      "street": "Uhlandstraße 60",
      "zip": "50969",
      "city": "Köln",
      "country": "Deutschland",
      "content_updated_at": "2016-07-06T15:03:30+02:00",
      "slug": "unicef",
      "name": "UNICEF",
      "description": "UNICEF, das Kinderhilfswerk der Vereinten Nationen, arbeitet weltweit mit Programmen in rund 150 Ländern. UNICEF hilft, dass das Recht jedes Kindes auf Überleben, Bildung und Schutz Wirklichkeit wird: mit konkreten Projekten, umfassenden Programmen und politischer Lobbyarbeit. UNICEF ist in jedem Land seit vielen Jahren vor Ort und hat ein dichtes Netzwerk lokaler Partner. So ist nachhaltige und effiziente Hilfe möglich. Mit dem jährlichen Geschäftsbericht informiert UNICEF ausführlich über Arbeitsweise, Strukturen und Kosten. Sie finden ihn unter www.unicef.de",
      "tax_deductible": true,
      "contact": {
        "id": 20505,
        "name": "J. Schuler",
        "picture": {
          "links": [
            {
              "rel": "fill_100x100",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/020/505/fill_100x100_original_Hell__Beatrix.JPG"
            },
            {
              "rel": "original",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/020/505/crop_original_original_Hell__Beatrix.JPG"
            }
          ]
        },
        "links": [
          {
            "rel": "platform",
            "href": "https://www.betterplace.org/de/users/20505"
          },
          {
            "rel": "contact_data",
            "href": "https://api.betterplace.org/de/api_v4/users/20505/contact_data.json"
          }
        ]
      },
      "picture": {
        "links": [
          {
            "rel": "fill_100x100",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_100x100_original_UNICEFLogoClaimrgb.jpg"
          },
          {
            "rel": "fill_200x200",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_200x200_original_UNICEFLogoClaimrgb.jpg"
          },
          {
            "rel": "fill_400x400",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_400x400_original_UNICEFLogoClaimrgb.jpg"
          },
          {
            "rel": "original",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/crop_original_original_UNICEFLogoClaimrgb.jpg"
          }
        ]
      },
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/organisations/2262.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/organisations/2262-unicef"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/organisations/2262/projects.json"
        },
        {
          "rel": "website",
          "href": "http://www.unicef.de"
        }
      ]
    },
    {
      "id": 125,
      "created_at": "2008-02-06T17:10:42+01:00",
      "updated_at": "2018-03-15T15:39:43+01:00",
      "latitude": 53.55759811401367,
      "longitude": 9.96815967559815,
      "street": "Dorfplatz 174",
      "zip": "20357",
      "city": "Hamburg",
      "country": "Deutschland",
      "content_updated_at": "2016-07-06T15:01:06+02:00",
      "slug": "vivaconagua",
      "name": "Viva con Agua de Sankt Pauli e.V.",
      "description": "Die Organisation Viva con Agua:<br><br>Viva con Agua de Sankt Pauli e.V. ist eine international tätige Wasserinitiative und wird vom FC St. Pauli ideell unterstützt. Initiator Benjamin Adrion, ehemaliger Mittelfeldspieler des Fußballclubs, gründete 2005 nach einem Trainingslager auf Kuba den gemeinnützigen Verein. <br><br>Ziel der Initiative ist es, die Versorgung mit sauberem Trinkwasser und sanitären Anlagen in Entwicklungsländern nachhaltig zu verbessern. Viva con Agua ist Projektpartner der Welthungerhilfe.<br><br>21 Projekte in 15 Projektländern hat Viva con Agua bereits in Zusammenarbeit mit der Welthungerhilfe realisiert und damit über 300.000 Menschen Zugang zu sauberem Trinkwasser ermöglicht. Des Weiteren haben mehr als 100.000 Schüler und Studenten im deutschsprachigen Raum VcA-Bildungsworkshops, Seminare und Spendenläufe mitgemacht.<br><br>Auszeichnungen:<br><br>ISPO Award 2013<br>HAMMA Award 2012<br>Utopia Award 2012<br>B.A.U.M.-Umweltpreis 2011<br>Werkstatt N-Projekt 2010<br>Bundesverdienstkreuz 2009<br>Utopia Award 2008<br>Ausgewählter Ort im Land der Ideen 2007 (Schirmherrschaft Bundespräsident Horst Köhler)<br>Bundessieger start social 2007 (Schirmherrschaft Bundeskanzlerin Angela Merkel)<br>taz-Panter-Preis 2006 <br><br><br>Aktivitäten und Initiativen<br><br>Viva con Agua veranstaltet laufend Konzerte, Partys, Sport- und Kulturevents, deren Erlöse als Spende in Trinkwasserprojekte fließen.<br><br>Schärfung des Bewusstseins, besonders bei jungen Menschen in Deutschland, für die Themen Wasser und Entwicklungshilfe ist das zweite wichtige Anliegen von Viva con Agua.<br><br>Die Sensibilisierung für diese Bereiche soll einerseits durch die zahlreichen Veranstaltungen von Viva con Agua erfolgen, aber auch in intensiver Bildungsarbeit an Schulen. Damit führt Viva con Agua schon frühzeitig Kinder und Jugendliche an soziales und humanitäres Engagement heran.",
      "tax_deductible": true,
      "contact": {
        "id": 520218,
        "name": "Kiana W.",
        "picture": {
          "links": [
            {
              "rel": "fill_100x100",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/520/218/fill_100x100_bp1484581782_mg6_20160712_0477.jpg"
            },
            {
              "rel": "original",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/520/218/crop_original_bp1484581782_mg6_20160712_0477.jpg"
            }
          ]
        },
        "links": [
          {
            "rel": "platform",
            "href": "https://www.betterplace.org/de/users/520218"
          },
          {
            "rel": "contact_data",
            "href": "https://api.betterplace.org/de/api_v4/users/520218/contact_data.json"
          }
        ]
      },
      "picture": {
        "links": [
          {
            "rel": "fill_100x100",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_100x100_VcA_Projektlogo.jpg"
          },
          {
            "rel": "fill_200x200",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_200x200_VcA_Projektlogo.jpg"
          },
          {
            "rel": "fill_400x400",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_400x400_VcA_Projektlogo.jpg"
          },
          {
            "rel": "original",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/crop_original_VcA_Projektlogo.jpg"
          }
        ]
      },
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/organisations/125.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/organisations/125-viva-con-agua-de-sankt-pauli-e-v"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/organisations/125/projects.json"
        },
        {
          "rel": "website",
          "href": "http://www.vivaconagua.org"
        }
      ]
    }
  ]
}