SDMXRequestParams: Class "SDMXRequestParams"

Description

A class to handle a SDMX service request params

Usage

SDMXRequestParams(regUrl, repoUrl, accessKey,
                   providerId, agencyId, resource, resourceId, version,
                   flowRef, key, start, end, references = NULL, compliant)

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 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.
providerId: an object of class "character" giving the provider agency id
agencyId: an object of class "character" giving an agency id
resource: an object of class "character" giving the type of resource to be queried
resourceId: an object of class "character" giving the resource to be queried
version: an object of class "character" giving the resource version
flowRef: an object of class "character" giving the flowRef to be queried
key: an object of class "character" giving the key (SDMX url formatted) to be used for the query
start: an object of class "character" giving the start time
end: an object of class "character" giving the end time
references: an object of class "character" giving the instructions to return (or not) the artefacts referenced by the artefact to be returned
compliant: an object of class "logical" indicating if the web-service is compliant with the SDMX REST web-service specifications

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

providerId

an object of class "character" giving the provider agency Id

agencyId

an object of class "character" giving an agency Id

resource

an object of class "character" giving the type of resource to be queried

resourceId

an object of class "character" giving the resource to be queried

version

an object of class "character" giving the resource version

flowRef

an object of class "character" giving the flowRef to be queried

key

an object of class "character" giving the key (SDMX url formatted) to be used for the query

start

an object of class "character" giving the start time

end

an object of class "character" giving the end time

references

an object of class "character" giving the instructions to return (or not) the artefacts referenced by the artefact to be returned

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

Emmanuel Blondel, emmanuel.blondel1@gmail.com

Examples

Run this code

  #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
  )

Run the code above in your browser using DataLab