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

Project Details ⇄ List

GET https://api.betterplace.org/de/api_v4/projects/1114.json

The details of a betterplace.org project (donate money).

For betterplace.org clients: Use this resource as follows: /clients/PERMALINK/projects/ID.json

URL Parameters

Parameter Example Required Description
id 1114 yes

Project id as an integer number ≥ 14.

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) when the project was created by the project manager.

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)

activated_at null | string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone) when the project was activated by us, otherwise it is null.

title string

Max 50 character

description string

A description of the project. This may contain any of the following HTML tags: a, b, br, div, em, i, iframe, img, li, ol, p, strong, ul.

summary string

A short summary of the project..

tax_deductible boolean true

True if the project marked as tax deductible. If so, Users can request a tax receipt that can be used with the German tax authorities. More about this.

donations_prohibited boolean false

True if the project must not receive donations. This might happen, for example, if a tax receipt of German tax authorities ran out.

Please check this flag whenever you display a donation button. Should you show a button for a project that cannot receive donations the user will open the donation form and see an error message on betterplace.org instead!

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

DateTime (ISO8601 with Timezone) of the moment the project was fully funded (100% progress_percentage).

A completed project may still be active (as in not closed). See `closed_at for details.

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

DateTime (ISO8601 with Timezone) when the project was closed by the project manager.

A closed project does not have to be fully funded. See completed_at for details.

open_amount_in_cents number 12382

How many cents are needed to complete the project

donated_amount_in_cents number 12382

How many cents are donated already. This includes:

  • sum of all donations
  • sum of all forwardings to the project
  • external donations

Subtracting:

  • backwardings from the project
positive_opinions_count number 13

Number of positive opinions that are given to a project without a donation. Those are plain opinions as well as visitor opinions.

DEPRECATED 2017-06-23

Use donations_count and comments_count instead. There is no distinction between positive and negative comments any more, all opinions were converted into comments.

negative_opinions_count number 0

Number of negative opinions (usually 0) that are given to a project without a donation. Those are plain opinions as well as visitor opinions. Critical opinions are part of the betterplace.org "Web of trust".

DEPRECATED 2017-06-23

Always returns 0. Don't use this field any more.

donations_count number 42

Count of confirmed donations for this project

comments_count number 24

Count of all comments for this project. This contains positive and negative reviews of the project, questions and answers by the project manager, as well as comments from users.

donor_count number 46

Number of unique donors, based on the payment-email-address

progress_percentage number 82

% financed. Note: We have legacy projects with substantial donation needs (pre ~2014). This percentage includes those needs.

incomplete_need_count number 6

Number of needs that still need donations

completed_need_count number 12

Number of completed needs

blog_post_count number 8

Number of blogposts (all types)

↓contact object TODO

The public face of the project / project manager

↓carrier object TODO

The organisation that carries this project

↓profile_picture null | object

TODO

↓active_matching_fund null | object TODO

DEPRECATED Do not use this data. We will remove the nested matching fund data in the future.

To get this data follow the active_matching_fund link and retrieve the data from the appropriate endpoint.

↓closed_notice null | object TODO

This is an experimental feature and is still under heavy development. Please use it with caution.

↑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: carrier

Attribute Types Example Description
carrier.name string "Till B."

The carrier can be an organisation or user.

carrier.city string "Berlin"

The city in which the carrier resides

↓carrier.picture object https://betterplace-assets.betterplace.org/…

The organisation logo, user profile picture or a fallback image

↑Nested Attributes: carrier.picture

Attribute Types Example Description
carrier.picture.fallback boolean true

Specifies whether a fallback image is given or not

↑Nested Attributes: profile_picture

Attribute Types Example Description
profile_picture.fallback boolean true

Specifies whether a fallback image is given or not

↑Nested Attributes: active_matching_fund

Attribute Types Example Description
active_matching_fund.id number 1

An integer number ≥ 1

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

DateTime (ISO8601 with Timezone)

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

DateTime (ISO8601 with Timezone)

active_matching_fund.activated_at null | string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

active_matching_fund.title string ACME Matching Everything

Our matching fund's name

active_matching_fund.description string It's all about matching donations…

The description of the matching fund

active_matching_fund.company_name string ACME

The company that supports it

active_matching_fund.client_id string clientname

The client to which the matching fund belongs

active_matching_fund.provided_amount_in_cents number 12300

The amount in cents the company provided to be matched

active_matching_fund.donated_amount_in_cents number 12300

The amount in cents the company already donated

active_matching_fund.state string activated

Current state of this matching fund: either activated or closed

active_matching_fund.logo_url string http://example.com/images/logo.png

The URL of the logo image.

active_matching_fund.maximum_matching_amount_in_cents number 10000

Up to this amount donations get matched by the matching fund

↑Nested Attributes: closed_notice

Attribute Types Example Description
closed_notice.text null | string Thank you for the successful funding.

A close notice from the project manager

Response Links

Linkname Description

self

Link to this resource itself (project details)

platform

Permalink to betterplace.org

opinions

Link to opinions list

pictures

Link to project pictures list

needs

Link to project needs list

blog_posts

Link to blog posts list

active_matching_fund

Link to matching fund

video

Link to a youtube video of this project

matching_funds

Link to matching funds list

new_client_donation

Link to the donation form. Templated, needs insertion of the client_id.

new_donation

Link to the regular donation form.

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.

carrier.self

Link to this resource itself (organisation details) Note: Since the there is no api for users yet, this is only set for organisations.

carrier.picture.fill_100x100

100×100 Pixel

carrier.picture.original

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

profile_picture.fill_960x500

950×500 Pixel

profile_picture.fill_730x380

730×380 Pixel

profile_picture.fill_618x322

618×322 Pixel / DEPRECATED, will be removed after 5/2015

profile_picture.fill_410x214

410×214 Pixel

profile_picture.fill_270x141

270×141 Pixel / DEPRECATED, will be removed after 5/2015

profile_picture.original

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

active_matching_fund.self

Link to this resource itself (matching fund details)

active_matching_fund.platform

Permalink to betterplace.org

active_matching_fund.projects

Link to the list of projects belonging to this matching fund

active_matching_fund.documentation

Link to this resource in the documentation

closed_notice.call_to_action

A link to a final blog post, the next project url or any other followup information for the donors.

Response Example

{
  "id": 1114,
  "created_at": "2009-03-10T11:12:16+01:00",
  "updated_at": "2018-03-29T00:04:49+02:00",
  "latitude": 34.531617284782,
  "longitude": 69.13581752939456,
  "street": "Siedlung 134",
  "zip": "",
  "city": "Kabul",
  "country": "Afghanistan",
  "content_updated_at": "2017-07-24T16:25:11+02:00",
  "activated_at": "2009-03-10T12:29:29+01:00",
  "title": "Skateistan Afghanistan",
  "description": "<div>With 68% of Afghanistan’s population under the age of 25, Skateistan strongly believes that youth are the ones most capable of bringing about social change.<br><br>Skateistan is an Afghan NGO which operates Afghanistan’s (and the world’s) first co-educational skateboarding school. The Skateistan school engages nearly 400 Kabul youth weekly through skateboarding, and provides them with new opportunities in cross-cultural interaction, education, and personal empowerment programs. <br><br>The students (ages 5-17) come from all of Afghanistan’s diverse ethnic and socioeconomic backgrounds, and include 40% female students, hundreds of streetworking children, and youth with disabilities. They develop skills in skateboarding, leadership, problem-solving, multimedia, and creative arts. The students themselves decide what they want to learn; we connect them with a safe space and opportunities for them to develop the skills that they consider important. <br><br>For Afghan girls Skateistan's programming is especially important as there are very few recreational opportunities for females. For example, it is not culturally acceptable for girls in Afghanistan to ride bicycles or play sports in public. <br><br>Skateistan has been active in Kabul since 2007 - with our facility built in 2009 - and in that time we’ve seen that Afghan youth of all ethnicities, genders, and socioeconomic backgrounds love to skateboard. Skateistan brings them together, equipping young men and women to lead their communities toward social change and development.<br><br>In 2012 Skateistan will be opening its second Afghan facility in Mazar-e-Sharif, Northern Afghanistan. It will have space to teach up to 1000 youth weekly.<br><br>Our program gives hundreds of oppressed youth a voice. Education and the opportunity for self-expression can break the cycles of poverty, illiteracy and exclusion, with sport paving the way.</div>",
  "summary": "Skateistan wurde als humanitäres Hilfsprojekt für Kinder und Jugendliche in Afghanistan im Jahr 2007 gegründet. Skateistan will Kindern in Kabul neue Perspektiven eröffnen, Vorurteile abbauen, Gleichberechtigung fördern und Freude bringen.",
  "tax_deductible": true,
  "donations_prohibited": false,
  "completed_at": null,
  "closed_at": null,
  "open_amount_in_cents": 815617,
  "donated_amount_in_cents": 5748235,
  "positive_opinions_count": 779,
  "negative_opinions_count": 0,
  "donations_count": 779,
  "comments_count": 0,
  "donor_count": 574,
  "progress_percentage": 87,
  "incomplete_need_count": 4,
  "completed_need_count": 93,
  "blog_post_count": 92,
  "contact": {
    "id": 287126,
    "name": "A. Wolff",
    "picture": {
      "fallback": true,
      "links": [
        {
          "rel": "fill_100x100",
          "href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/fill_100x100_default.jpg"
        },
        {
          "rel": "original",
          "href": "https://betterplace-assets.betterplace.org/assets/default/user_profile_picture/fill_100x100_default.jpg"
        }
      ]
    },
    "links": [
      {
        "rel": "platform",
        "href": "https://www.betterplace.org/de/users/287126"
      },
      {
        "rel": "contact_data",
        "href": "https://api.betterplace.org/de/api_v4/users/287126/contact_data.json"
      }
    ]
  },
  "carrier": {
    "name": "Skateistan",
    "city": "Berlin",
    "picture": {
      "links": [
        {
          "rel": "fill_100x100",
          "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/001/054/fill_100x100_original_betterplace-logo.png"
        },
        {
          "rel": "original",
          "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/001/054/crop_original_original_betterplace-logo.png"
        }
      ]
    },
    "links": [
      {
        "rel": "self",
        "href": "https://api.betterplace.org/de/api_v4/organisations/1054.json"
      }
    ]
  },
  "profile_picture": {
    "links": [
      {
        "rel": "fill_960x500",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/fill_960x500_original_girls-merza-sm.jpg"
      },
      {
        "rel": "fill_730x380",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/fill_730x380_original_girls-merza-sm.jpg"
      },
      {
        "rel": "fill_618x322",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/fill_618x322_original_girls-merza-sm.jpg"
      },
      {
        "rel": "fill_410x214",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/fill_410x214_original_girls-merza-sm.jpg"
      },
      {
        "rel": "fill_270x141",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/fill_270x141_original_girls-merza-sm.jpg"
      },
      {
        "rel": "original",
        "href": "https://betterplace-assets.betterplace.org/uploads/project/profile_picture/000/001/114/crop_original_original_girls-merza-sm.jpg"
      }
    ]
  },
  "active_matching_fund": null,
  "closed_notice": null,
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114.json"
    },
    {
      "rel": "platform",
      "href": "https://www.betterplace.org/de/projects/1114-skateistan-afghanistan"
    },
    {
      "rel": "opinions",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114/opinions.json"
    },
    {
      "rel": "pictures",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114/pictures.json"
    },
    {
      "rel": "needs",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114/needs.json"
    },
    {
      "rel": "blog_posts",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114/blog_posts.json"
    },
    {
      "rel": "matching_funds",
      "href": "https://api.betterplace.org/de/api_v4/matching_funds.json?project_id=1114"
    },
    {
      "rel": "new_client_donation",
      "href": "https://www.betterplace.org/de/projects/1114/client_donations/new?client_id=%7Bclient_id%7D",
      "templated": true
    },
    {
      "rel": "new_donation",
      "href": "https://www.betterplace.org/de/projects/1114/donations/new"
    }
  ]
}