Method: OpenapiClient::XHRVerticallyIntegratedApi#xhr_employees20230301_with_http_info

Defined in:
lib/openapi_client/api/xhr_vertically_integrated_api.rb

#xhr_employees20230301_with_http_info(opts = {}) ⇒ Array<(Array<EmployeeResponse>, Integer, Hash)>

Employees List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employment_status (EmploymentStatusNotNullNotNullable) —

    Optional query parameter. Use to enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)

Returns:

  • (Array<(Array<EmployeeResponse>, Integer, Hash)>) —

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



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
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 94

def xhr_employees20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.xhr_employees20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/employees'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<EmployeeResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"XHRVerticallyIntegratedApi.xhr_employees20230301",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XHRVerticallyIntegratedApi#xhr_employees20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end