1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Class-SDMXREST21RequestBuilder.R,
% R/SDMXREST21RequestBuilder-methods.R
\docType{class}
\name{SDMXREST21RequestBuilder}
\alias{SDMXREST21RequestBuilder}
\alias{SDMXREST21RequestBuilder-class}
\alias{SDMXREST21RequestBuilder,SDMXREST21RequestBuilder-method}
\title{Class "SDMXREST21RequestBuilder"}
\usage{
SDMXREST21RequestBuilder(regUrl, repoUrl, accessKey = NULL, compliant,
unsupportedResources = list(), skipProviderId = FALSE, forceProviderId = FALSE,
headers = list())
}
\arguments{
\item{regUrl}{an object of class "character" giving the base Url of the SDMX
service registry}
\item{repoUrl}{an object of class "character" giving the base Url of the SDMX
service repository}
\item{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}
\item{compliant}{an object of class "logical" indicating if the web-service
is compliant with the SDMX REST web-service specifications}
\item{unsupportedResources}{an object of class "list" giving eventual unsupported
REST resources. Default is an empty list object}
\item{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.}
\item{forceProviderId}{an object of class "logical" indicating if the provider
agencyId has to be added at the end of the request. Default value is
\code{FALSE}. For some providers, the \code{all} value for the provider
agency id is not allowed, in this case, the \code{agencyId} of the data
provider has to be forced in the web-request.}
\item{headers}{an object of class "list" that contains any additional headers for the request.}
}
\description{
A experimental class to handle a SDMX 2.1 service request builder
}
\section{Slots}{
\describe{
\item{\code{regUrl}}{an object of class "character" giving the base Url of the SDMX service registry}
\item{\code{repoUrl}}{an object of class "character" giving the base Url of the SDMX service repository}
\item{\code{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}
\item{\code{compliant}}{an object of class "logical" indicating if the web-service is compliant with the SDMX REST web-service specifications}
}}
\section{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.
}
\examples{
#how to create a SDMXREST21RequestBuilder
requestBuilder <- SDMXREST21RequestBuilder(
regUrl = "http://www.myorg/registry",
repoUrl = "http://www.myorg/repository",
compliant = TRUE)
}
\author{
Emmanuel Blondel, \email{emmanuel.blondel1@gmail.com}
}
|
