Skip to content

Latest commit

 

History

History
278 lines (189 loc) · 9.64 KB

BoardExcludedMembersApi.md

File metadata and controls

278 lines (189 loc) · 9.64 KB
Raw

Spinen\ConnectWise\Clients\Service\BoardExcludedMembersApi

Spinen's PHP ConnectWise Client for Service API generated by Swagger Code Generator.

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

Method HTTP request Description
serviceBoardsIdExcludedMembersCountGet GET /service/boards/{id}/excludedMembers/count
serviceBoardsIdExcludedMembersExcludedMemberIdDelete DELETE /service/boards/{id}/excludedMembers/{excludedMemberId}
serviceBoardsIdExcludedMembersExcludedMemberIdGet GET /service/boards/{id}/excludedMembers/{excludedMemberId}
serviceBoardsIdExcludedMembersGet GET /service/boards/{id}/excludedMembers
serviceBoardsIdExcludedMembersPost POST /service/boards/{id}/excludedMembers

serviceBoardsIdExcludedMembersCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceBoardsIdExcludedMembersCountGet($id, $conditions)

Get Excluded Members Count

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->serviceBoardsIdExcludedMembersCountGet($id, $conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersCountGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\Service\Model\Count

Authorization

BasicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

serviceBoardsIdExcludedMembersExcludedMemberIdDelete

serviceBoardsIdExcludedMembersExcludedMemberIdDelete($id, $excluded_member_id)

Delete Excluded Member By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$excluded_member_id = 56; // int | 

try {
    $api_instance->serviceBoardsIdExcludedMembersExcludedMemberIdDelete($id, $excluded_member_id);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersExcludedMemberIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
excluded_member_id int

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

serviceBoardsIdExcludedMembersExcludedMemberIdGet

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember serviceBoardsIdExcludedMembersExcludedMemberIdGet($id, $excluded_member_id)

Get Excluded Member By Id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$excluded_member_id = 56; // int | 

try {
    $result = $api_instance->serviceBoardsIdExcludedMembersExcludedMemberIdGet($id, $excluded_member_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersExcludedMemberIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
excluded_member_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember

Authorization

BasicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

serviceBoardsIdExcludedMembersGet

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember[] serviceBoardsIdExcludedMembersGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Excluded Members

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 
$order_by = "order_by_example"; // string | 
$childconditions = "childconditions_example"; // string | 
$customfieldconditions = "customfieldconditions_example"; // string | 
$page = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $api_instance->serviceBoardsIdExcludedMembersGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
conditions string [optional]
order_by string [optional]
childconditions string [optional]
customfieldconditions string [optional]
page int [optional]
page_size int [optional]

Return type

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember[]

Authorization

BasicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

serviceBoardsIdExcludedMembersPost

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember serviceBoardsIdExcludedMembersPost($id, $excluded_member)

Create Excluded Member

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Service\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardExcludedMembersApi();
$id = 56; // int | 
$excluded_member = new \Spinen\ConnectWise\Clients\Service\Model\ExcludedMember(); // \Spinen\ConnectWise\Clients\Service\Model\ExcludedMember | 

try {
    $result = $api_instance->serviceBoardsIdExcludedMembersPost($id, $excluded_member);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardExcludedMembersApi->serviceBoardsIdExcludedMembersPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
excluded_member \Spinen\ConnectWise\Clients\Service\Model\ExcludedMember

Return type

\Spinen\ConnectWise\Clients\Service\Model\ExcludedMember

Authorization

BasicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]