style_formats: Endpoint functions

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

Description

The style_formats implements operations to access and manipulate LCCS-WS Style Formats endpoints (LCCS-WS-SPEC 0.6)

Usage

style_formats(q, style_format_id = NULL, params_list = list())

Arguments

q	a RLCCSQuery object expressing a LCCS query criteria.
style_format_id	A integer containing the ID of the Style Format. This parameter is optional. When it is not set, the list of all registered Style Formats is retrieved (the add operation must be done without this parameter). On the other hand, its setting causes the retrieval and management operations to be done for a particular Style Format.
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 style_formats for /style_formats/ endpoint, or a style_formats_id subclass for /style_formats/style_format_id/ 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.

All classification systems in LCCS are linked to a Style Format. This allow the use of classification_system_id class subclass object to this endpoint and retrieve the Style Format related information for a specific Classification System. This use returns subclass style_formats_classification to /classification_systems/system_id/style_formats/ endpoint.

See Also

get_request, post_request, put_request, delete_request

Examples

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

lccs("https://brazildatacube.dpi.inpe.br/dev/lccs/") %>%
  style_formats(style_format_id = 3) %>%
  get_request()

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

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