Class: PsiEligibility::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/psi_eligibility/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/psi_eligibility/api/default_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/psi_eligibility/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_candidate_eligibility(account_code, candidate_id, test_code, opts = {}) ⇒ nil

Cancel a candidate’s eligibility record. Cancels the eligibility matching the supplied candidate eligiblity code.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    The unique candidate id to act on.

  • test_code —

    The test code.

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/psi_eligibility/api/default_api.rb', line 29

def cancel_candidate_eligibility(, candidate_id, test_code, opts = {})
  cancel_candidate_eligibility_with_http_info(, candidate_id, test_code, opts)
  nil
end

#cancel_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel a candidate&#39;s eligibility record. Cancels the eligibility matching the supplied candidate eligiblity code.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    The unique candidate id to act on.

  • test_code —

    The test code.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
76
77
78
79
80
81
82
83
84
 
# File 'lib/psi_eligibility/api/default_api.rb', line 41

def cancel_candidate_eligibility_with_http_info(, candidate_id, test_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.cancel_candidate_eligibility ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.cancel_candidate_eligibility"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.cancel_candidate_eligibility"
  end
  # verify the required parameter 'test_code' is set
  if @api_client.config.client_side_validation && test_code.nil?
    fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.cancel_candidate_eligibility"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', .to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#create_candidate(account_code, payload, opts = {}) ⇒ EligibilityResponseModel

Create a new candidate eligibility record. Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.

Parameters:

  • account_code —

    provided client specific account code.

  • payload —

    A new eligibility record.

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/psi_eligibility/api/default_api.rb', line 91

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

#create_candidate_with_http_info(account_code, payload, opts = {}) ⇒ Array<(EligibilityResponseModel, Fixnum, Hash)>

Create a new candidate eligibility record. Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.

Parameters:

  • account_code —

    provided client specific account code.

  • payload —

    A new eligibility record.

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

    the optional parameters

Returns:

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

    EligibilityResponseModel data, response status code and response headers



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/psi_eligibility/api/default_api.rb', line 102

def create_candidate_with_http_info(, payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_candidate ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.create_candidate"
  end
  # verify the required parameter 'payload' is set
  if @api_client.config.client_side_validation && payload.nil?
    fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.create_candidate"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates'.sub('{' + 'account_code' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payload)
  auth_names = ['oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EligibilityResponseModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_candidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_candidate(account_code, candidate_id, opts = {}) ⇒ Array<ExistingEligibilityModel>

Get the eligiblities associated with the candidate id. Get’s all of the eligibilities associated with the supplied candidate_id. This is useful to decide which specific eligibility needs to be updated or deleted.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    the candidate id.

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/psi_eligibility/api/default_api.rb', line 151

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

#get_candidate_eligibilities(account_code, candidate_id, test_code, opts = {}) ⇒ Array<ExistingEligibilityModel>

Get the eligiblities associated with the candidate id. Get’s all of the eligibilities associated with the supplied candidate_id fpr a specific test code.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    the candidate id.

  • test_code —

    The test code.

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/psi_eligibility/api/default_api.rb', line 210

def get_candidate_eligibilities(, candidate_id, test_code, opts = {})
  data, _status_code, _headers = get_candidate_eligibilities_with_http_info(, candidate_id, test_code, opts)
  data
end

#get_candidate_eligibilities_with_http_info(account_code, candidate_id, test_code, opts = {}) ⇒ Array<(Array<ExistingEligibilityModel>, Fixnum, Hash)>

Get the eligiblities associated with the candidate id. Get&#39;s all of the eligibilities associated with the supplied candidate_id fpr a specific test code.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    the candidate id.

  • test_code —

    The test code.

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

    the optional parameters

Returns:

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

    Array<ExistingEligibilityModel> data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/psi_eligibility/api/default_api.rb', line 222

def get_candidate_eligibilities_with_http_info(, candidate_id, test_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_candidate_eligibilities ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.get_candidate_eligibilities"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.get_candidate_eligibilities"
  end
  # verify the required parameter 'test_code' is set
  if @api_client.config.client_side_validation && test_code.nil?
    fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.get_candidate_eligibilities"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', .to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'Array<ExistingEligibilityModel>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_candidate_eligibilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_candidate_with_http_info(account_code, candidate_id, opts = {}) ⇒ Array<(Array<ExistingEligibilityModel>, Fixnum, Hash)>

Get the eligiblities associated with the candidate id. Get&#39;s all of the eligibilities associated with the supplied candidate_id. This is useful to decide which specific eligibility needs to be updated or deleted.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    the candidate id.

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

    the optional parameters

Returns:

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

    Array<ExistingEligibilityModel> data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/psi_eligibility/api/default_api.rb', line 162

def get_candidate_with_http_info(, candidate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_candidate ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.get_candidate"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.get_candidate"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates/{candidate_id}'.sub('{' + 'account_code' + '}', .to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'Array<ExistingEligibilityModel>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_candidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_test_launch_info(psi_eligibility_code, opts = {}) ⇒ TestLaunchInfoModel

GET test launch url API endpoint to retrieve the test launch URL for a given eligibility code.

Parameters:

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/psi_eligibility/api/default_api.rb', line 272

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

#get_test_launch_info_with_http_info(psi_eligibility_code, opts = {}) ⇒ Array<(TestLaunchInfoModel, Fixnum, Hash)>

GET test launch url API endpoint to retrieve the test launch URL for a given eligibility code.

Parameters:

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

    the optional parameters

Returns:

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

    TestLaunchInfoModel data, response status code and response headers



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/psi_eligibility/api/default_api.rb', line 282

def get_test_launch_info_with_http_info(psi_eligibility_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_test_launch_info ...'
  end
  # verify the required parameter 'psi_eligibility_code' is set
  if @api_client.config.client_side_validation && psi_eligibility_code.nil?
    fail ArgumentError, "Missing the required parameter 'psi_eligibility_code' when calling DefaultApi.get_test_launch_info"
  end
  # resource path
  local_var_path = '/eligibilities/{psi_eligibility_code}/testLaunchInfo'.sub('{' + 'psi_eligibility_code' + '}', psi_eligibility_code.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['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 => 'TestLaunchInfoModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_test_launch_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_vouchers_of_eligibility(account_code, candidate_id, test_code, opts = {}) ⇒ nil

Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)

Parameters:

  • account_code —

    Account code or the customer code

  • candidate_id —

    Candidate Id

  • test_code —

    Test Code

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

    the optional parameters

Options Hash (opts):

  • :payload (Array<String>) —

    Voucher Codes to be applied to the candidate&#39;s specified exam record

Returns:

  • (nil) 


326
327
328
329
 
# File 'lib/psi_eligibility/api/default_api.rb', line 326

def modify_vouchers_of_eligibility(, candidate_id, test_code, opts = {})
  modify_vouchers_of_eligibility_with_http_info(, candidate_id, test_code, opts)
  nil
end

#modify_vouchers_of_eligibility_with_http_info(account_code, candidate_id, test_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)

Parameters:

  • account_code —

    Account code or the customer code

  • candidate_id —

    Candidate Id

  • test_code —

    Test Code

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

    the optional parameters

Options Hash (opts):

  • :payload (Array<String>) —

    Voucher Codes to be applied to the candidate&#39;s specified exam record

Returns:

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

    nil, response status code and response headers



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/psi_eligibility/api/default_api.rb', line 338

def modify_vouchers_of_eligibility_with_http_info(, candidate_id, test_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.modify_vouchers_of_eligibility ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.modify_vouchers_of_eligibility"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.modify_vouchers_of_eligibility"
  end
  # verify the required parameter 'test_code' is set
  if @api_client.config.client_side_validation && test_code.nil?
    fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.modify_vouchers_of_eligibility"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}/vouchers'.sub('{' + 'account_code' + '}', .to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)

  # 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 = @api_client.object_to_http_body(opts[:'payload'])
  auth_names = ['oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#modify_vouchers_of_eligibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_candidate_eligibility(account_code, candidate_id, test_code, payload, opts = {}) ⇒ nil

Update an existing candidate’s eligibility record. Update an existing candidate’s eligibility details. Information such as candidate demographic data and eligibility, expiration and scheduled start date may be changed. You cannot change the associated test via this call. To do so you must cancel and create a new eligibility.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    The unique candidate id to update.

  • test_code —

    The test code.

  • payload —

    The candidate&#39;s updated eligibity record.

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

    the optional parameters

Returns:

  • (nil) 


392
393
394
395
 
# File 'lib/psi_eligibility/api/default_api.rb', line 392

def update_candidate_eligibility(, candidate_id, test_code, payload, opts = {})
  update_candidate_eligibility_with_http_info(, candidate_id, test_code, payload, opts)
  nil
end

#update_candidate_eligibility_with_http_info(account_code, candidate_id, test_code, payload, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update an existing candidate&#39;s eligibility record. Update an existing candidate&#39;s eligibility details. Information such as candidate demographic data and eligibility, expiration and scheduled start date may be changed. You cannot change the associated test via this call. To do so you must cancel and create a new eligibility.

Parameters:

  • account_code —

    provided client specific account code.

  • candidate_id —

    The unique candidate id to update.

  • test_code —

    The test code.

  • payload —

    The candidate&#39;s updated eligibity record.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/psi_eligibility/api/default_api.rb', line 405

def update_candidate_eligibility_with_http_info(, candidate_id, test_code, payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_candidate_eligibility ...'
  end
  # verify the required parameter 'account_code' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_code' when calling DefaultApi.update_candidate_eligibility"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling DefaultApi.update_candidate_eligibility"
  end
  # verify the required parameter 'test_code' is set
  if @api_client.config.client_side_validation && test_code.nil?
    fail ArgumentError, "Missing the required parameter 'test_code' when calling DefaultApi.update_candidate_eligibility"
  end
  # verify the required parameter 'payload' is set
  if @api_client.config.client_side_validation && payload.nil?
    fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.update_candidate_eligibility"
  end
  # resource path
  local_var_path = '/accounts/{account_code}/candidates/{candidate_id}/tests/{test_code}'.sub('{' + 'account_code' + '}', .to_s).sub('{' + 'candidate_id' + '}', candidate_id.to_s).sub('{' + 'test_code' + '}', test_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payload)
  auth_names = ['oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#update_candidate_eligibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end