SDMXREST20RequestBuilder: Class "SDMXREST20RequestBuilder"
In opensdmx/rsdmx: Tools for Reading SDMX Data and Metadata

View source: R/SDMXREST20RequestBuilder-methods.R

SDMXREST20RequestBuilder

R Documentation

Class "SDMXREST20RequestBuilder"

Description

A experimental class to handle a SDMX 2.0 service request builder

Usage

SDMXREST20RequestBuilder(regUrl, repoUrl, accessKey = NULL, compliant,
   unsupportedResources = list(), skipProviderId = FALSE, forceProviderId = FALSE,
   headers = list())

Arguments

`regUrl`	an object of class "character" giving the base Url of the SDMX service registry
`repoUrl`	an object of class "character" giving the base Url of the SDMX service repository
`accessKey`	an object of class "character" indicating the name of request parameter for which an authentication or subscription user key/token has to be provided to perform requests
`compliant`	an object of class "logical" indicating if the web-service is compliant with the SDMX REST web-service specifications
`unsupportedResources`	an object of class "list" giving eventual unsupported REST resources. Default is an empty list object
`skipProviderId`	an object of class "logical" indicating that the provider agencyIdshould be skipped. Used to control lack of strong SDMX REST compliance from data providers. For now, it applies only for the "data" resource.
`forceProviderId`	an object of class "logical" indicating if the provider agencyId has to be added at the end of the request. Default value is `FALSE`. For some providers, the `all` value for the provider agency id is not allowed, in this case, the `agencyId` of the data provider has to be forced in the web-request
`headers`	an object of class "list" that contains any additional headers for the request.

Slots

regUrl: an object of class "character" giving the base Url of the SDMX service registry
repoUrl: an object of class "character" giving the base Url of the SDMX service repository
accessKey: an object of class "character" indicating the name of request parameter for which an authentication or subscription user key/token has to be provided to perform requests
compliant: an object of class "logical" indicating if the web-service is compliant with the SDMX REST web-service specifications

Warning

This class is not useful in itself, but all SDMX non-abstract classes will encapsulate it as slot, when parsing an SDMX-ML document.

Author(s)

Emmanuel Blondel, emmanuel.blondel1@gmail.com

Examples

  #how to create a SDMXREST20RequestBuilder
  requestBuilder <- SDMXREST20RequestBuilder(
    regUrl = "http://www.myorg/registry",
    repoUrl = "http://www.myorg/repository", compliant = FALSE)

opensdmx/rsdmx documentation built on Feb. 12, 2024, 12:13 a.m.