Class: RusticiSoftwareCloudV2::ReportingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/api/reporting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReportingApi

Returns a new instance of ReportingApi.



19
20
21
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_account_info(opts = {}) ⇒ ReportageAccountInfoSchema

Get account information Returns all of the account information for the specified application.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 26

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#get_account_info_with_http_info(opts = {}) ⇒ Array<(ReportageAccountInfoSchema, Fixnum, Hash)>

Get account information Returns all of the account information for the specified application.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReportageAccountInfoSchema, Fixnum, Hash)>) —

    ReportageAccountInfoSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 35

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportingApi.get_account_info ...'
  end
  # resource path
  local_var_path = '/reporting/accountInfo'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportageAccountInfoSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportingApi#get_account_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reportage_auth_token(nav_permission, opts = {}) ⇒ ReportageAuthTokenSchema

Get a Reportage session authentication token Returns a session authentication token to use when launching Reportage.

Parameters:

  • nav_permission —

    The navigation permissions for this Reportage session

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :admin (BOOLEAN) —

    Grant admin privileges to this Reportage session (default to false)

Returns:



76
77
78
79
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 76

def get_reportage_auth_token(nav_permission, opts = {})
  data, _status_code, _headers = get_reportage_auth_token_with_http_info(nav_permission, opts)
  data
end

#get_reportage_auth_token_with_http_info(nav_permission, opts = {}) ⇒ Array<(ReportageAuthTokenSchema, Fixnum, Hash)>

Get a Reportage session authentication token Returns a session authentication token to use when launching Reportage.

Parameters:

  • nav_permission —

    The navigation permissions for this Reportage session

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :admin (BOOLEAN) —

    Grant admin privileges to this Reportage session

Returns:

  • (Array<(ReportageAuthTokenSchema, Fixnum, Hash)>) —

    ReportageAuthTokenSchema data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 87

def get_reportage_auth_token_with_http_info(nav_permission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_auth_token ...'
  end
  # verify the required parameter 'nav_permission' is set
  if nav_permission.nil?
    fail ArgumentError, "Missing the required parameter 'nav_permission' when calling ReportingApi.get_reportage_auth_token"
  end
  # resource path
  local_var_path = '/reporting/reportageAuth'

  # query parameters
  query_params = {}
  query_params[:'navPermission'] = nav_permission
  query_params[:'admin'] = opts[:'admin'] if !opts[:'admin'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportageAuthTokenSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportingApi#get_reportage_auth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reportage_link(auth, report_url, opts = {}) ⇒ ReportageLinkSchema

Get a link to a page in Reportage with the given permissions Returns the link to use for viewing Reportage. In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.

Parameters:

  • auth —

    The Reportage authentication token retrieved from a previous call to &#x60;GET reportageAuth&#x60;

  • report_url —

    The Reportage URL to try and access. Common values are the Reportage homepage &#x60;cloud.scorm.com/Reportage/reportage.php?appId&#x3D;appId}&#x60; or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 134

def get_reportage_link(auth, report_url, opts = {})
  data, _status_code, _headers = get_reportage_link_with_http_info(auth, report_url, opts)
  data
end

#get_reportage_link_with_http_info(auth, report_url, opts = {}) ⇒ Array<(ReportageLinkSchema, Fixnum, Hash)>

Get a link to a page in Reportage with the given permissions Returns the link to use for viewing Reportage. In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.

Parameters:

  • auth —

    The Reportage authentication token retrieved from a previous call to &#x60;GET reportageAuth&#x60;

  • report_url —

    The Reportage URL to try and access. Common values are the Reportage homepage &#x60;cloud.scorm.com/Reportage/reportage.php?appId&#x3D;appId}&#x60; or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReportageLinkSchema, Fixnum, Hash)>) —

    ReportageLinkSchema data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/rustici_software_cloud_v2/api/reporting_api.rb', line 145

def get_reportage_link_with_http_info(auth, report_url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_link ...'
  end
  # verify the required parameter 'auth' is set
  if auth.nil?
    fail ArgumentError, "Missing the required parameter 'auth' when calling ReportingApi.get_reportage_link"
  end
  # verify the required parameter 'report_url' is set
  if report_url.nil?
    fail ArgumentError, "Missing the required parameter 'report_url' when calling ReportingApi.get_reportage_link"
  end
  # resource path
  local_var_path = '/reporting/reportageLink'

  # query parameters
  query_params = {}
  query_params[:'auth'] = auth
  query_params[:'reportUrl'] = report_url

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportageLinkSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportingApi#get_reportage_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end