Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.1 KB

CertificationsApi.md

File metadata and controls

372 lines (249 loc) · 12.1 KB

Spinen\ConnectWise\Clients\System\CertificationsApi

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
systemCertificationsCountGet GET /system/certifications/count
systemCertificationsGet GET /system/certifications
systemCertificationsIdDelete DELETE /system/certifications/{id}
systemCertificationsIdGet GET /system/certifications/{id}
systemCertificationsIdPatch PATCH /system/certifications/{id}
systemCertificationsIdPut PUT /system/certifications/{id}
systemCertificationsPost POST /system/certifications

systemCertificationsCountGet

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

Get Certification 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\CertificationsApi();
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->systemCertificationsCountGet($conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CertificationsApi->systemCertificationsCountGet: ', $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]

systemCertificationsGet

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

Get Certification

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\CertificationsApi();
$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->systemCertificationsGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CertificationsApi->systemCertificationsGet: ', $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\Certification[]

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]

systemCertificationsIdDelete

systemCertificationsIdDelete($id)

Delete Certification 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\CertificationsApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
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]

systemCertificationsIdGet

\Spinen\ConnectWise\Clients\System\Model\Certification systemCertificationsIdGet($id)

Get Certification 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\CertificationsApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\Certification

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]

systemCertificationsIdPatch

\Spinen\ConnectWise\Clients\System\Model\Certification systemCertificationsIdPatch($id, $operations)

Update Certification

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\CertificationsApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\System\Model\PatchOperation[] | 

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

Parameters

Name Type Description Notes
id int
operations \Spinen\ConnectWise\Clients\System\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\System\Model\Certification

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]

systemCertificationsIdPut

\Spinen\ConnectWise\Clients\System\Model\Certification systemCertificationsIdPut($id, $certification)

Replace Certification

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\CertificationsApi();
$id = 56; // int | 
$certification = new \Spinen\ConnectWise\Clients\System\Model\Certification(); // \Spinen\ConnectWise\Clients\System\Model\Certification | 

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

Parameters

Name Type Description Notes
id int
certification \Spinen\ConnectWise\Clients\System\Model\Certification

Return type

\Spinen\ConnectWise\Clients\System\Model\Certification

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]

systemCertificationsPost

\Spinen\ConnectWise\Clients\System\Model\Certification systemCertificationsPost($certification)

Create Certification

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\CertificationsApi();
$certification = new \Spinen\ConnectWise\Clients\System\Model\Certification(); // \Spinen\ConnectWise\Clients\System\Model\Certification | 

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

Parameters

Name Type Description Notes
certification \Spinen\ConnectWise\Clients\System\Model\Certification

Return type

\Spinen\ConnectWise\Clients\System\Model\Certification

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]