Skip to content

Latest commit

 

History

History
646 lines (620 loc) · 18.6 KB

volunteering_details.md

File metadata and controls

646 lines (620 loc) · 18.6 KB

Volunteering Details ⇄ List

GET https://api.betterplace.org/de/api_v4/volunteering/28428.json

The details of a betterplace.org volunteering offer (donate time).

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

URL Parameters

Parameter Example Required Description
id 28428 yes Volunteering-id as an integer number ≥ 1.

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
title string TODO Max 100 character unless the volunteering is imported
description string TODO TODO
↓carrier object TODO An organisation, Users will be added later
vacancies number 1 The number of volunteers that are needed, provided by the manager
↓image null | object TODO Each volunteering has one optional image / DEPRECATED, will be removed after 5/2015
↓contact object TODO Contact person, contact data and contact address
topics array ["Development cooperation", "Children & youth"] Up to 4 categories that describe, what for which causes you need volunteers. Results are translated to the requested language. Possible results: "Animal & environment protection", "Culture & sports", "Children & youth", "Development cooperation ", "DisabledEducation", "Elderly people", "Human rights", "Refugees & immigrants", "Invalid", "Local help", "Socially deprived"
activities array | null ["consulting/coaching", "office work"] Up to 4 categories that describe, what for which causes you need volunteers. Results are translated to the requested language. Possible results: "consulting/coaching", "crafting/gardening", "doing sports", "doing the chores", "group care", "nursing/parenting", "office work", "organising/managing", "painting/designing", "tutoring/reading", "visiting/accompanying", "writing/translating"
imported_from null | string aktion_mensch Betterplace imports volunteering offers from Aktions Mensch.
↓import_information null | object TODO Meta data concerning the import of this volunteering offer, if it was indeed imported.
↓profile_picture null | object TODO
### ↑Nested Attributes: carrier
Attribute Types Example Description
carrier.latitude number 52.499007 Decimal degrees based on user input
carrier.longitude number 13.44947 Decimal degrees based on user input
carrier.name string "Viva con Agua de Sankt Pauli e.V." An organisation name, Users will be added later
carrier.street string "Rosenstr. 3" Contact data for the organisation
carrier.city string "Berlin" Contact data for the organisation
carrier.zip string "10123" Contact data for the organisation
carrier.country string "Germany" Contact data for the organisation
↓carrier.picture null | object TODO
### ↑Nested Attributes: carrier.picture
Attribute Types Example Description
carrier.picture.fallback boolean true Specifies whether a fallback image is given or not
### ↑Nested Attributes: image
Attribute Types Example Description
image.description string Image description
### ↑Nested Attributes: contact
Attribute Types Example Description
contact.name string Till Behnke Fullname of the contact person. For imported volunteering offers, this is the contact-name that is provided on import.
contact.phone string 030 - 7676 4488 44 Phone number for direct contact. No validations on input apply.
contact.email string support@betterplace.org Plain text email-address for direct contact
↓contact.picture string //assets.betterplace.org/… 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: import_information
Attribute Types Example Description
import_information.created_at null | string "1994-11-05T13:15:30Z" DateTime (ISO8601 with Timezone) when the imported record was actually created.
import_information.updated_at null | string "1994-11-05T13:15:30Z" DateTime (ISO8601 with Timezone) when the imported record was actually updated last.
import_information.import_type string "Import::ImportFormat" Type of import this record originated from.
import_information.import_id string "foo:23" Unique identifier for this imported record.
import_information.imported_at string "1994-11-15T13:15:30Z" DateTime (ISO8601 with Timezone) when the record was imported at betterplace.
### ↑Nested Attributes: profile_picture
Attribute Types Example Description
profile_picture.fallback boolean true Specifies whether a fallback image is given or not

Response Links

<tr>
  <th align="left">self</th>
  <td>Link to this resource itself

(volunteering details)

Linkname Description
platform Permalink to betterplace.org
carrier.picture.fill_100x100 100×100 Pixel
carrier.picture.fill_200x200 200×200 Pixel
carrier.picture.fill_400x400 400×400 Pixel
carrier.picture.original Maximum sized image. This is the original image with default-cropping or user-cropping applied.
image.fill_618x322 618×322 Pixel / DEPRECATED, will be removed after 5/2015
image.fill_270x141 270×141 Pixel / DEPRECATED, will be removed after 5/2015
image.original Original size / DEPRECATED, will be removed after 5/2015
image.thumb Thumbnail size / DEPRECATED, will be removed after 5/2015
image.medium Medium size / DEPRECATED, will be removed after 5/2015
image.regular Regular size / DEPRECATED, will be removed after 5/2015
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.
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.

Response Example

{
  "id": 28428,
  "created_at": "2015-11-04T18:07:48+01:00",
  "updated_at": "2016-01-07T17:19:36+01:00",
  "latitude": 53.6815,
  "longitude": 9.98472,
  "street": "Ochsenzoller Straße 134",
  "zip": "22848",
  "city": "Norderstedt",
  "country": "Deutschland",
  "title": "SOS - Public Relation - Texter - Pressesprecher gesucht",
  "description": "SOS und Hilfe,\r\n\r\nwir kümmern uns um Kinder mit und ohne Migrantionshintergrund.\r\nDarin sind wir gut - sehr gut sogar, wenn man den Eltern Glauben schenken kann.\r\n\r\nWir sind aber auch ein Paria unter den Kindergärten dieser Welt und schwimmen gegen den Strom (gegen den Strom der Obrigkeit, nicht den der Kinder und Eltern!).\r\n\r\nWir starten gerade mehrere Aktionen in der Öffentlichkeit und brauchen dringend proffesionelle Hilfe und Unterstützung in Sachen PR.\r\nSelbstverständlich ist jegliche Tätigkeit im Zusammenhang mit dem gemeinnützigen Verein versichert.",
  "carrier": {
    "latitude": 53.6815137,
    "longitude": 9.98471559999996,
    "name": "Musischer Jugendkreis Norderstedt e.V.",
    "street": "Ochsenzoller Straße 134",
    "city": "Norderstedt",
    "zip": "22848",
    "country": "Deutschland",
    "picture": {
      "fallback": true,
      "links": [
        {
          "rel": "fill_100x100",
          "href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_100x100_F_chse_LOGO.jpg"
        },
        {
          "rel": "fill_200x200",
          "href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_200x200_F_chse_LOGO.jpg"
        },
        {
          "rel": "fill_400x400",
          "href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_400x400_F_chse_LOGO.jpg"
        },
        {
          "rel": "original",
          "href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/crop_original_F_chse_LOGO.jpg"
        }
      ]
    },
    "links": [

    ]
  },
  "vacancies": 1,
  "image": {
    "description": "Die KIDS brauchen uns und vor allem Dich",
    "links": [
      {
        "rel": "fill_618x322",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_618x322_Gruppenbild_.jpg"
      },
      {
        "rel": "fill_270x141",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_270x141_Gruppenbild_.jpg"
      },
      {
        "rel": "original",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/Gruppenbild_.jpg"
      },
      {
        "rel": "thumb",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/thumb_Gruppenbild_.jpg"
      },
      {
        "rel": "medium",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/medium_Gruppenbild_.jpg"
      },
      {
        "rel": "regular",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/regular_Gruppenbild_.jpg"
      }
    ]
  },
  "contact": {
    "name": "Ulrich Eidecker",
    "phone": "040-523 23 81",
    "email": "eidecker@focus-success.de",
    "picture": null,
    "links": [

    ]
  },
  "topics": [
    "Bildung",
    "Kinder & Jugendliche",
    "Flüchtlinge & Migranten",
    "Sozial Benachteiligte"
  ],
  "activities": [
    "PR / Social Media"
  ],
  "imported_from": null,
  "import_information": null,
  "profile_picture": {
    "fallback": true,
    "links": [
      {
        "rel": "fill_960x500",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_960x500_Gruppenbild_.jpg"
      },
      {
        "rel": "fill_730x380",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_730x380_Gruppenbild_.jpg"
      },
      {
        "rel": "fill_618x322",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_618x322_Gruppenbild_.jpg"
      },
      {
        "rel": "fill_410x214",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_410x214_Gruppenbild_.jpg"
      },
      {
        "rel": "fill_270x141",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/fill_270x141_Gruppenbild_.jpg"
      },
      {
        "rel": "original",
        "href": "https://asset1.betterplace.org/uploads/bettertime/job_description/profile_picture/000/028/428/crop_original_Gruppenbild_.jpg"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/volunteering/28428.json"
    },
    {
      "rel": "platform",
      "href": "https://www.betterplace.org/de/volunteering/28428-sos-public-relation-texter-pressesprecher-gesucht"
    }
  ]
}