Skip to content

Latest commit

 

History

History
267 lines (204 loc) · 4.74 KB

need_details.md

File metadata and controls

267 lines (204 loc) · 4.74 KB

Project Need Details ⇄ List

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

The details of a betterplace.org project need (donate money). The details and list view show the same data per project need.

For betterplace.org clients: There is no client-scoped URL. Please use the API calls that are provided inside the client project url response to make sure you only request data that is associated with one of your projects.

URL Parameters

Parameter Example Required Description
project_id 1114 yes

Project id as an integer number.
id 59220 yes

Need-id as an integer number.

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)
title string

Max 50 character
description string
completed boolean false

True if the need is 100 % financed
progress_percentage number 82

% financed
donated_amount_in_cents number 12382

How many cents are donated already. This includes all donations that can be given to a need (direct donation, forwarding of project donation, forwarding of organisation donation, forwarding of fundraising event donations, offline donations and also(!) external donations)
open_amount_in_cents number 12382

How many cents are still needed to complete the need
requested_amount_in_cents number 12382

How much money is needed in total

Response Links

Linkname Description

self

Link to this resource itself (need details)

project

Link to the related project's details

new_client_donation

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

new_donation

Link to the regular donation form.

Response Example

{
  "id": 357682,
  "created_at": "2021-11-23T13:43:53+01:00",
  "updated_at": "2022-08-30T08:42:43+02:00",
  "title": "Skateistan: A New Chapter",
  "description": "Unser Ziel: im Laufe des nächsten Jahres auf 20 Standorte zu expandieren und jede Woche 4 500 Schüler zu erreichen. Helft uns, das nächste Kapitel der Geschichte von Skateistan zu schreiben!",
  "completed": false,
  "progress_percentage": 22.03,
  "donated_amount_in_cents": 110135,
  "open_amount_in_cents": 389865,
  "requested_amount_in_cents": 500000,
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114/needs/357682.json"
    },
    {
      "rel": "project",
      "href": "https://api.betterplace.org/de/api_v4/projects/1114.json"
    },
    {
      "rel": "new_client_donation",
      "href": "https://www.betterplace.org/de/donate/%7Bclient_id%7D/projects/1114?need_id=357682",
      "templated": true
    },
    {
      "rel": "new_donation",
      "href": "https://www.betterplace.org/de/donate/platform/projects/1114?need_id=357682"
    }
  ]
}