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

Volunteering Details ⇄ List

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

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

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

URL Parameters

Parameter Example Required Description
id 57545 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

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

DateTime (ISO8601 with Timezone)

title string TODO

Max 100 character unless the volunteering is imported

description string

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

↓carrier object TODO

The organisation that carrier this volunteering

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

location_fixed boolean true

Specifies whether the volunteering offer is limited to a certain location or if it may be executed remotely.

working_time_selection string regular commitment

Working time selection, specifies if this is a one-time event or if this volunteering can takes place regulary.

working_time_weekends array ["in the mornings"]

Up to three working time preferences. They specify when this volunteering should take place on weekends.

working_time_weekdays array ["in the mornings"]

Up to three working time preferences. They specify when this volunteering should take place on weekdays.

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

DateTime (ISO8601 with Timezone)

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

DateTime (ISO8601 with Timezone)

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 object https://betterplace-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

Linkname Description

self

Link to this resource itself (volunteering details)

platform

Permalink to betterplace.org

inquiries

The URL to which inquiries about this offer can be POSTed (inquiry details). Templated, needs insertion of the client_id.

carrier.self

Link to this resource itself (organisation details)

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": 57545,
  "created_at": "2018-06-20T11:26:43+02:00",
  "updated_at": "2018-06-20T11:26:43+02:00",
  "latitude": 51.1673,
  "longitude": 6.44075,
  "street": "Friedrich-Ebert Str. 53",
  "zip": "41236",
  "city": "Mönchengladbach",
  "country": "Deutschland",
  "content_updated_at": "2018-06-20T11:26:43+02:00",
  "title": "Freiwilligen Zentrum Mönchengladbach",
  "description": "Bewerbungstraining<br><br>Für ein Gruppenangebot im Herbst 2018 wird ein(e) Ehrenamtliche(r) gesucht, der/die einmal wöchentlich vier Wochen in Folge jeweils eine Einheit à 3 Stunden Bewerbungstraining durchführt. In den einzelnen Einheiten sollen die Interessen, Stärken und Ressourcen der TeilnehmerInnen, das Bewerbungsschreiben, der Lebenslauf und potenzielle Vorstellungsgespräche bearbeitet werden.",
  "carrier": null,
  "vacancies": 1,
  "image": {
    "description": null,
    "links": [
      {
        "rel": "fill_618x322",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_618x322_default.png"
      },
      {
        "rel": "fill_270x141",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_270x141_default.png"
      },
      {
        "rel": "original",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_730x380_default.png"
      },
      {
        "rel": "thumb",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/thumb_default.png"
      },
      {
        "rel": "medium",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/medium_default.png"
      },
      {
        "rel": "regular",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/regular_default.png"
      }
    ]
  },
  "contact": {
    "name": "Angela Mirbach",
    "phone": "02166 - 40207",
    "email": "fwz-mg@caritas-mg.de",
    "picture": null,
    "links": [

    ]
  },
  "location_fixed": true,
  "working_time_selection": "egal wann / nach Vereinbarung",
  "working_time_weekends": [

  ],
  "working_time_weekdays": [

  ],
  "begins_at": null,
  "ends_at": null,
  "topics": [
    "Bildung",
    "Kinder & Jugendliche",
    "Flüchtlinge & Migranten",
    "Sozial Benachteiligte"
  ],
  "activities": [

  ],
  "imported_from": "aktion_mensch",
  "import_information": {
    "created_at": "2018-06-06T00:00:00+02:00",
    "updated_at": "2018-06-06T00:00:00+02:00",
    "import_type": "Bettertime::AktionMensch::Import",
    "import_id": "am-6515",
    "imported_at": "2018-06-20T11:26:43+02:00",
    "links": [

    ]
  },
  "profile_picture": {
    "fallback": true,
    "links": [
      {
        "rel": "fill_960x500",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_960x500_default.png"
      },
      {
        "rel": "fill_730x380",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_730x380_default.png"
      },
      {
        "rel": "fill_618x322",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_618x322_default.png"
      },
      {
        "rel": "fill_410x214",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_410x214_default.png"
      },
      {
        "rel": "fill_270x141",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/fill_270x141_default.png"
      },
      {
        "rel": "original",
        "href": "https://betterplace-assets.betterplace.org/assets/default/job_description_profile_picture/crop_original_default.png"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/volunteering/57545.json"
    },
    {
      "rel": "platform",
      "href": "https://www.betterplace.org/de/volunteering/57545-freiwilligen-zentrum-monchengladbach"
    },
    {
      "rel": "inquiries",
      "href": "https://api.betterplace.org/de/api_v4/clients/%7Bclient_id%7D/volunteering/57545-freiwilligen-zentrum-monchengladbach/inquiries.json",
      "templated": true
    }
  ]
}