ConnectWise::ApiMembersApi

All URIs are relative to http://cloud.na.myconnectwise.net/v4_6_development/apis/3.0

Method	HTTP request	Description
get_system_api_members	GET /system/apiMembers	Get List of ApiMember
get_system_api_members_by_id	GET /system/apiMembers/{id}	Get ApiMember
get_system_api_members_count	GET /system/apiMembers/count	Get Count of
get_system_api_members_default	GET /system/apiMembers/default	Get ApiMember
patch_system_api_members_by_id	PATCH /system/apiMembers/{id}	Patch ApiMember
post_system_api_members	POST /system/apiMembers	Post ApiMember
put_system_api_members_by_id	PUT /system/apiMembers/{id}	Put ApiMember

get_system_api_members

<Array> get_system_api_members(client_id, opts)

Get List of ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of ApiMember
  result = api_instance.get_system_api_members(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members: #{e}"
end

Using the get_system_api_members_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_system_api_members_with_http_info(client_id, opts)

begin
  # Get List of ApiMember
  data, status_code, headers = api_instance.get_system_api_members_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ApiMember>>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
client_id	String
conditions	String	[optional]
child_conditions	String	[optional]
custom_field_conditions	String	[optional]
order_by	String	[optional]
fields	String	[optional]
page	Integer	[optional]
page_size	Integer	[optional]
page_id	Integer	[optional]

Return type

Array<ApiMember>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

get_system_api_members_by_id

get_system_api_members_by_id(id, client_id, opts)

Get ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
id = 56 # Integer | apiMemberId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get ApiMember
  result = api_instance.get_system_api_members_by_id(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_by_id: #{e}"
end

Using the get_system_api_members_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_system_api_members_by_id_with_http_info(id, client_id, opts)

begin
  # Get ApiMember
  data, status_code, headers = api_instance.get_system_api_members_by_id_with_http_info(id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiMember>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	apiMemberId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

ApiMember

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

get_system_api_members_count

get_system_api_members_count(client_id, opts)

Get Count of

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of
  result = api_instance.get_system_api_members_count(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_count: #{e}"
end

Using the get_system_api_members_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_system_api_members_count_with_http_info(client_id, opts)

begin
  # Get Count of
  data, status_code, headers = api_instance.get_system_api_members_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_count_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
client_id	String
conditions	String	[optional]
child_conditions	String	[optional]
custom_field_conditions	String	[optional]
order_by	String	[optional]
fields	String	[optional]
page	Integer	[optional]
page_size	Integer	[optional]
page_id	Integer	[optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

get_system_api_members_default

get_system_api_members_default(client_id, opts)

Get ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get ApiMember
  result = api_instance.get_system_api_members_default(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_default: #{e}"
end

Using the get_system_api_members_default_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_system_api_members_default_with_http_info(client_id, opts)

begin
  # Get ApiMember
  data, status_code, headers = api_instance.get_system_api_members_default_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiMember>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->get_system_api_members_default_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
client_id	String
conditions	String	[optional]
child_conditions	String	[optional]
custom_field_conditions	String	[optional]
order_by	String	[optional]
fields	String	[optional]
page	Integer	[optional]
page_size	Integer	[optional]
page_id	Integer	[optional]

Return type

ApiMember

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

patch_system_api_members_by_id

patch_system_api_members_by_id(id, client_id, patch_operation)

Patch ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
id = 56 # Integer | apiMemberId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch ApiMember
  result = api_instance.patch_system_api_members_by_id(id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->patch_system_api_members_by_id: #{e}"
end

Using the patch_system_api_members_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_system_api_members_by_id_with_http_info(id, client_id, patch_operation)

begin
  # Patch ApiMember
  data, status_code, headers = api_instance.patch_system_api_members_by_id_with_http_info(id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiMember>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->patch_system_api_members_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	apiMemberId
client_id	String
patch_operation	Array<PatchOperation>	List of PatchOperation

Return type

ApiMember

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

post_system_api_members

post_system_api_members(client_id, api_member)

Post ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
client_id = 'client_id_example' # String | 
api_member = ConnectWise::ApiMember.new({identifier: 'identifier_example'}) # ApiMember | apiMember

begin
  # Post ApiMember
  result = api_instance.post_system_api_members(client_id, api_member)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->post_system_api_members: #{e}"
end

Using the post_system_api_members_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_system_api_members_with_http_info(client_id, api_member)

begin
  # Post ApiMember
  data, status_code, headers = api_instance.post_system_api_members_with_http_info(client_id, api_member)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiMember>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->post_system_api_members_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
client_id	String
api_member	ApiMember	apiMember

Return type

ApiMember

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

put_system_api_members_by_id

put_system_api_members_by_id(id, client_id, api_member)

Put ApiMember

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ApiMembersApi.new
id = 56 # Integer | apiMemberId
client_id = 'client_id_example' # String | 
api_member = ConnectWise::ApiMember.new({identifier: 'identifier_example'}) # ApiMember | apiMember

begin
  # Put ApiMember
  result = api_instance.put_system_api_members_by_id(id, client_id, api_member)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->put_system_api_members_by_id: #{e}"
end

Using the put_system_api_members_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_system_api_members_by_id_with_http_info(id, client_id, api_member)

begin
  # Put ApiMember
  data, status_code, headers = api_instance.put_system_api_members_by_id_with_http_info(id, client_id, api_member)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiMember>
rescue ConnectWise::ApiError => e
  puts "Error when calling ApiMembersApi->put_system_api_members_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	apiMemberId
client_id	String
api_member	ApiMember	apiMember

Return type

ApiMember

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

Files

ApiMembersApi.md

Latest commit

History

ApiMembersApi.md

File metadata and controls

ConnectWise::ApiMembersApi

get_system_api_members

Examples

Using the get_system_api_members_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_api_members_by_id

Examples

Using the get_system_api_members_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_api_members_count

Examples

Using the get_system_api_members_count_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_api_members_default

Examples

Using the get_system_api_members_default_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

patch_system_api_members_by_id

Examples

Using the patch_system_api_members_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

post_system_api_members

Examples

Using the post_system_api_members_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

put_system_api_members_by_id

Examples

Using the put_system_api_members_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers