api_get_bathingspot: Get Bathing Spot(s)

Description Usage Arguments

View source: R/api_bathingspot.R

Description

Get Bathing Spot(s)

Usage

1
2
3
4
5
6
7
8
api_get_bathingspot(
  user_id = -1L,
  spot_id = -1L,
  limit = NULL,
  skip = NULL,
  pattern = "",
  check = TRUE
)

Arguments

user_id

user ID or -1L (all users)

spot_id

bathing spot ID or -1L (all bathing spots)

limit

passed to fhpredict:::path_bathingspot

skip

passed to fhpredict:::path_bathingspot

pattern

optional. Pattern matching the names of bathing spots to be returned. Only considered if no spot_id is given (i.e. has its default value -1L).

check

if TRUE (the default) it is checked first whether the given user_id exists. Switching this check off may speed up the request.


KWB-R/fhpredict documentation built on Nov. 1, 2020, 5:58 a.m.