Skip to content

OthersApi.md

Latest commit

 

History

History
386 lines (283 loc) · 11.1 KB

OthersApi.md

File metadata and controls

386 lines (283 loc) · 11.1 KB

ConnectWise::OthersApi

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

Method HTTP request Description
get_system_my_company_other GET /system/myCompany/other Get List of Other
get_system_my_company_other_by_id GET /system/myCompany/other/{id} Get Other
get_system_my_company_other_count GET /system/myCompany/other/count Get Count of Other
patch_system_my_company_other_by_id PATCH /system/myCompany/other/{id} Patch Other
put_system_my_company_other_by_id PUT /system/myCompany/other/{id} Put Other

get_system_my_company_other

<Array> get_system_my_company_other(client_id, opts)

Get List of Other

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OthersApi.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 Other
  result = api_instance.get_system_my_company_other(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OthersApi->get_system_my_company_other: #{e}"
end

Using the get_system_my_company_other_with_http_info variant

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

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

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

Parameters

Name Type Description 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<Other>

Authorization

No authorization required

HTTP request headers

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

get_system_my_company_other_by_id

get_system_my_company_other_by_id(id, client_id, opts)

Get Other

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OthersApi.new
id = 56 # Integer | otherId
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 Other
  result = api_instance.get_system_my_company_other_by_id(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OthersApi->get_system_my_company_other_by_id: #{e}"
end

Using the get_system_my_company_other_by_id_with_http_info variant

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

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

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

Parameters

Name Type Description Notes
id Integer otherId
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

Other

Authorization

No authorization required

HTTP request headers

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

get_system_my_company_other_count

get_system_my_company_other_count(client_id, opts)

Get Count of Other

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OthersApi.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 Other
  result = api_instance.get_system_my_company_other_count(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OthersApi->get_system_my_company_other_count: #{e}"
end

Using the get_system_my_company_other_count_with_http_info variant

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

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

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

Parameters

Name Type Description 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=2025.1

patch_system_my_company_other_by_id

patch_system_my_company_other_by_id(id, client_id, patch_operation)

Patch Other

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_system_my_company_other_by_id_with_http_info variant

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

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

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

Parameters

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

Return type

Other

Authorization

No authorization required

HTTP request headers

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

put_system_my_company_other_by_id

put_system_my_company_other_by_id(id, client_id, other)

Put Other

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::OthersApi.new
id = 56 # Integer | otherId
client_id = 'client_id_example' # String | 
other = ConnectWise::Other.new({default_from_address: 'default_from_address_example', portal_url_override: 'portal_url_override_example', site_url: 'site_url_example', server_time_zone: ConnectWise::TimeZoneSetupReference.new, default_calendar: ConnectWise::CalendarReference.new, default_address_format: ConnectWise::AddressFormatReference.new, locale: ConnectWise::LocaleReference.new}) # Other | other

begin
  # Put Other
  result = api_instance.put_system_my_company_other_by_id(id, client_id, other)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling OthersApi->put_system_my_company_other_by_id: #{e}"
end

Using the put_system_my_company_other_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_system_my_company_other_by_id_with_http_info(id, client_id, other)

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

Parameters

Name Type Description Notes
id Integer otherId
client_id String
other Other other

Return type

Other

Authorization

No authorization required

HTTP request headers

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