API-Documentation - Categories

Categories

This module delivers all category information.

Function overview

get Get category for given id.
getAll Get all available categories
getWines Fetch all wines of one category by id.
getWithWines Get single category with wines
get - Get category for given id.post

Get a category for given id

Url

/service/categories/get

Parameter

Field Type Description
id Integer

Unique id for requested category (required).

Request-Example

{
  "id": 123
}
getAll - Get all available categoriespost

Get all available categories

Url

/service/categories/getAll

Parameter

No parameter available for this function

getWines - Fetch all wines of one category by id.post

Fetch all wines of one category by id.

Url

/service/categories/getWines

Parameter

Field Type Description
id Integer

Unique category ID.

[settings.resolverelations] Boolean

Wether to include winery record in result.

( Optional. Default value: false )

getWithWines - Get single category with winespost

Access data from one single category by giving one specific id with wines. Use this instead of the regular get method to increase your app performance.

Url

/service/categories/getWithWines

Parameter

Field Type Description
id Integer

Unique ID of wine (required).

Request-Example

{
  "id": 185
}

© 2021 Vinou GmbH, Mombacher Straße 68, 55122 Mainz, Germany