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
|
#' @name SDMXRequestParams
#' @rdname SDMXRequestParams
#' @aliases SDMXRequestParams,SDMXRequestParams-method
#'
#' @usage
#' SDMXRequestParams(regUrl, repoUrl, accessKey,
#' providerId, agencyId, resource, resourceId, version,
#' flowRef, key, start, end, references = NULL, compliant)
#'
#' @param regUrl an object of class "character" giving the base Url of the SDMX service registry
#' @param repoUrl an object of class "character" giving the base Url of the SDMX service repository
#' @param accessKey an oject of class "character" giving the eventual authentication or subscription
#' user key (or token) to provide in order to perform the SDMX request. This key may be
#' mandatory for some service providers.
#' @param providerId an object of class "character" giving the provider agency id
#' @param agencyId an object of class "character" giving an agency id
#' @param resource an object of class "character" giving the type of resource to be queried
#' @param resourceId an object of class "character" giving the resource to be queried
#' @param version an object of class "character" giving the resource version
#' @param flowRef an object of class "character" giving the flowRef to be queried
#' @param key an object of class "character" giving the key (SDMX url formatted) to be used for the query
#' @param start an object of class "character" giving the start time
#' @param end an object of class "character" giving the end time
#' @param references an object of class "character" giving the instructions to return (or not) the artefacts referenced by the artefact to be returned
#' @param compliant an object of class "logical" indicating if the web-service is compliant with the SDMX REST web-service specifications
#'
#' @examples
#' #how to create a SDMXRequestParams object
#' params <- SDMXRequestParams(
#' regUrl = "", repoUrl ="", accessKey = NULL,
#' providerId = "", agencyId ="", resource = "data", resourceId = "",
#' version = "", flowRef = "", key = NULL, start = NULL, end = NULL,
#' references = NULL, compliant = FALSE
#' )
#' @export
#'
SDMXRequestParams <- function(regUrl, repoUrl, accessKey, providerId, agencyId, resource, resourceId, version = NULL,
flowRef, key = NULL, start = NULL, end = NULL, references = NULL, compliant){
new("SDMXRequestParams",
regUrl = regUrl, repoUrl = repoUrl, accessKey = accessKey, providerId = providerId,
agencyId = agencyId, resource = resource, resourceId = resourceId, version = version,
flowRef = flowRef, key = key, start = start, end = end, references = references)
}
|
