Api-class.Rd 1.1 KB
Newer Older
Pauline Maury Laribière's avatar
Pauline Maury Laribière committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api_class.R
\docType{class}
\name{Api-class}
\alias{Api-class}
\alias{api_class}
\title{Api class to make appropriate request based on parameters}
\description{
Api class to make appropriate request based on parameters
}
\section{Fields}{

\describe{
\item{\code{api_type}}{character. The name of the api to call (see url_mapping)}

16
17
18
\item{\code{environment}}{environment on which to query API
Available are 'PRD', 'ABN', 'TEST', 'QA' and 'DEV'.}

19
20
\item{\code{export_format}}{character (default = "JSON"). The export's format
Available are CSV, XLSX, SDMX-ML and JSON}
Pauline Maury Laribière's avatar
Pauline Maury Laribière committed
21
22
23
24
25

\item{\code{parameters}}{character. Additional request parameters}

\item{\code{id}}{character. The identifier or id of the request's object}

26
27
\item{\code{language}}{character (default = "all"). Language of the response data.
Available are 'all', 'fr', 'de', 'it', 'en'}
Pauline Maury Laribière's avatar
Pauline Maury Laribière committed
28

29
\item{\code{version_format}}{numeric (default = 2.1). The export format's version
30
(2.0 or 2.1 when format is SDMX-ML)
Pauline Maury Laribière's avatar
Pauline Maury Laribière committed
31
32
33
34
35
36
(for 'codelist')}

\item{\code{api_url}}{character. The url to make the request to.}
}}