Resources

Resource Category

/api/categories?locale&page&per_page

Methods

GET

Retrieve the categories collection.

request query parameter
Parameter Type Description
locale string Localize categories with the given locale. Default is "de", valid are any of the available locales.
page integer For pagination, what page of the results you are on. Default is 1.
per_page integer For pagination, how many results to return per page. Default is 200. Max is 500.

Example request:

http://wheelmap.org/api/categories?api_key=api_key&locale=en&page=2&per_page=5

Representations

Example categories representation. (application/json)

{ "conditions":
    {
      "format":"json",
      "page":2,
      "per_page":5,
      "locale":"en"
    },
  "meta":
    {
      "page":2,
      "num_pages":3,
      "item_count":5,
      "item_count_total":11
    },
  "categories":[
    {
      "id":6,
      "localized_name":"Shopping",
      "identifier":"shopping"
    },{
      "id":7,
      "localized_name":"Sport",
      "identifier":"sport"
    },{
      "id":8,
      "localized_name":"Tourism",
      "identifier":"tourism"
    },{
      "id":9,
      "localized_name":"Accomodation",
      "identifier":"accommodation"
    },{
      "id":10,
      "localized_name":"Misc",
      "identifier":"misc"
    }
  ]
}