mappings: Endpoint functions

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

Description

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

Usage

mappings(q, system_id_source, system_id_target = NULL, params_list = list())

Arguments

q	a RLCCSQuery object expressing a LCCS query criteria.
system_id_source	A integer containing the ID of the classification system to which you want to check the associated mappings. This parameter is mandatory, and its use allows retrieving only the mappings associated with a classification system.
system_id_target	an integer representing the ID of the target classification system that you want to check for mappings. This parameter is optional and can be done when there is a need to check the mapping relationship between two classification systems. This parameter enables the use of all management routes (HTTP verbs POST, PUT, DELETE) of the mappings between two rating systems.
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 mappings_id_source for /mappings/system_id_source/ endpoint, or amappings_id_source_and_target subclass for /mappings/system_id_source/system_id_target endpoint containing operations results.

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/") %>%
  mappings(system_id_source = 3) %>%
  get_request()

lccs("https://brazildatacube.dpi.inpe.br/dev/lccs/") %>%
  mappings(system_id_source = 3, system_id_target = 5) %>%
  get_request()

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