Skip to content

Latest commit

 

History

History
238 lines (155 loc) · 5.48 KB

ProjectContactsApi.md

File metadata and controls

238 lines (155 loc) · 5.48 KB
Raw

Connectwise::ProjectContactsApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
project_projects_id_contacts_contact_id_delete DELETE /project/projects/{id}/contacts/{contactId}
project_projects_id_contacts_contact_id_get GET /project/projects/{id}/contacts/{contactId}
project_projects_id_contacts_get GET /project/projects/{id}/contacts
project_projects_id_contacts_post POST /project/projects/{id}/contacts

project_projects_id_contacts_contact_id_delete

project_projects_id_contacts_contact_id_delete(id, contact_id)

Delete Project Contact By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProjectContactsApi.new

id = 56 # Integer | 

contact_id = 56 # Integer | 


begin
  api_instance.project_projects_id_contacts_contact_id_delete(id, contact_id)
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectContactsApi->project_projects_id_contacts_contact_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
contact_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

project_projects_id_contacts_contact_id_get

ProjectContact project_projects_id_contacts_contact_id_get(id, contact_id)

Get Project Contact By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProjectContactsApi.new

id = 56 # Integer | 

contact_id = 56 # Integer | 


begin
  result = api_instance.project_projects_id_contacts_contact_id_get(id, contact_id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectContactsApi->project_projects_id_contacts_contact_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
contact_id Integer

Return type

ProjectContact

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

project_projects_id_contacts_get

Array<ProjectContact> project_projects_id_contacts_get(id, opts)

Get Project Contacts

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProjectContactsApi.new

id = 56 # Integer | 

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.project_projects_id_contacts_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectContactsApi->project_projects_id_contacts_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<ProjectContact>

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

project_projects_id_contacts_post

ProjectContact project_projects_id_contacts_post(id, contact)

Create Project Contact

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProjectContactsApi.new

id = 56 # Integer | 

contact = Connectwise::ProjectContact.new # ProjectContact | 


begin
  result = api_instance.project_projects_id_contacts_post(id, contact)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectContactsApi->project_projects_id_contacts_post: #{e}"
end

Parameters

Name Type Description Notes
id Integer
contact ProjectContact

Return type

ProjectContact

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json