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

Client-project tags list

GET https://api.betterplace.org/de/api_v4/clients/volksfreund/projects/4425/tags.json?order=projects_count%3ADESC

For betterplace.org clients only:

This API returns all tags assigned by this client for this project. Client project tags are a custom client feature and andministered as a service of betterplace solutions.

Results are contained in a data attribute.

To guarantee stable search results, all clients are required to specify an order with each request as explained below.

URL Parameters

Parameter Example Required Description
client_id volksfreund yes

The betterplace.org-internal client permalink

project_id 4425 yes

Project id as an integer number ≥ 14.

order projects_count:DESC no

Order the result set.
It is strongly recommended to specify an order with each request. The default order might change at any time without notice. A recommended order is projects_count:asc| slug:asc (without the spaces).
Supported orders are:

  • slug:ASC/DESC – tag name
  • projects_count:ASC/DESC - how many projects are using that client?
It is possible to set multiple facet filters. Learn how to format the parameter.

Response Attributes

Root Attributes

Attribute Types Example Description
tag string "Education"

The name of the tag. It is unique per client.

projects_count number 23

The number of projects that were tagged with this tag.

Response Links

Linkname Description

projects

Link to the client-tag projects list – all projects that are tagged with given client-tag.

Response Example

{
  "total_entries": 5,
  "offset": 0,
  "total_pages": 2,
  "current_page": 1,
  "per_page": 3,
  "data": [
    {
      "tag": "Trier",
      "projects_count": 31,
      "links": [
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/tags/Trier/projects.json"
        }
      ]
    },
    {
      "tag": "KinderJugendliche",
      "projects_count": 45,
      "links": [
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/tags/KinderJugendliche/projects.json"
        }
      ]
    },
    {
      "tag": "Familien",
      "projects_count": 11,
      "links": [
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/tags/Familien/projects.json"
        }
      ]
    }
  ]
}