Skip to content

Latest commit

 

History

History
272 lines (183 loc) · 8.74 KB

MembersApi.md

File metadata and controls

272 lines (183 loc) · 8.74 KB

Spinen\ConnectWise\Clients\System\MembersApi

Spinen's PHP ConnectWise Client for System 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
systemMembersCountGet GET /system/members/count
systemMembersGet GET /system/members
systemMembersMemberIdentifierGet GET /system/members/{memberIdentifier}
systemMembersMemberIdentifierImageGet GET /system/members/{memberIdentifier}/image
systemMembersMemberIdentifierTokensPost POST /system/members/{memberIdentifier}/tokens

systemMembersCountGet

\Spinen\ConnectWise\Clients\System\Model\Count systemMembersCountGet($conditions)

Get Members Count

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\MembersApi();
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

\Spinen\ConnectWise\Clients\System\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]

systemMembersGet

\Spinen\ConnectWise\Clients\System\Model\Member[] systemMembersGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Members

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\MembersApi();
$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->systemMembersGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MembersApi->systemMembersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
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\System\Model\Member[]

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]

systemMembersMemberIdentifierGet

\Spinen\ConnectWise\Clients\System\Model\Member systemMembersMemberIdentifierGet($member_identifier)

Get Member By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\MembersApi();
$member_identifier = "member_identifier_example"; // string | 

try {
    $result = $api_instance->systemMembersMemberIdentifierGet($member_identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MembersApi->systemMembersMemberIdentifierGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
member_identifier string

Return type

\Spinen\ConnectWise\Clients\System\Model\Member

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]

systemMembersMemberIdentifierImageGet

systemMembersMemberIdentifierImageGet($member_identifier, $use_default_flag, $lastmodified)

Get Member Image

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\MembersApi();
$member_identifier = "member_identifier_example"; // string | 
$use_default_flag = true; // bool | 
$lastmodified = "lastmodified_example"; // string | 

try {
    $api_instance->systemMembersMemberIdentifierImageGet($member_identifier, $use_default_flag, $lastmodified);
} catch (Exception $e) {
    echo 'Exception when calling MembersApi->systemMembersMemberIdentifierImageGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
member_identifier string
use_default_flag bool [optional]
lastmodified string [optional]

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

systemMembersMemberIdentifierTokensPost

\Spinen\ConnectWise\Clients\System\Model\Token systemMembersMemberIdentifierTokensPost($member_identifier)

Create Token By Member Identifier

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\System\Api\MembersApi();
$member_identifier = "member_identifier_example"; // string | 

try {
    $result = $api_instance->systemMembersMemberIdentifierTokensPost($member_identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MembersApi->systemMembersMemberIdentifierTokensPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
member_identifier string

Return type

\Spinen\ConnectWise\Clients\System\Model\Token

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]