classification_system: Endpoint functions

In brazil-data-cube/rlccs: R Client For Land Cover Classification System Web Service

Description

The classification_system implements operations to access and manipulate LCCS-WS Classification Systems endpoints (LCCS-WS-SPEC 0.6)

Usage

classification_systems(q, system_id = NULL, params_list = list())

Arguments

q	a RLCCSQuery object expressing a LCCS query criteria.
system_id	a optional character system_id used to get information about a specific Classification System
params_list	HTTP Body Parameter List. The elements entered in this list may vary depending on the method being used. See the specification for the usage details for each of the operations. (https://github.com/brazil-data-cube/lccs-ws-spec).

Value

A RLCCSQuery object with the subclass classification_system for /classification_system/ endpoint with information about registered Classification Systems or about a new Classification System inserted. The RLCCSQuery also can be represent as a subclass classification_systems_id for /classification_system/system_id for information or operations about a specific Classification System.

These operations' results are all represented in JSON format, with the content varying according to the HTTP method that was performed. For the retrieval, addition, or update of classes linked to a Classification System, the result summarizes what was retrieved/added. In the case of deletions, only the confirmation of the operation is presented.

See Also

get_request, post_request, put_request, delete_request

Examples

lccs("https://brazildatacube.dpi.inpe.br/dev/lccs/") %>%
  classification_systems() %>%
  get_request()

lccs("https://brazildatacube.dpi.inpe.br/dev/lccs/") %>%
  classification_systems(system_id = 2) %>%
  get_request()

brazil-data-cube/rlccs documentation built on Feb. 28, 2021, 5:50 p.m.