Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.2 KB

SkillCategoriesApi.md

File metadata and controls

372 lines (249 loc) · 12.2 KB

Spinen\ConnectWise\Clients\System\SkillCategoriesApi

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
systemSkillCategoriesCountGet GET /system/skillCategories/count
systemSkillCategoriesGet GET /system/skillCategories
systemSkillCategoriesIdDelete DELETE /system/skillCategories/{id}
systemSkillCategoriesIdGet GET /system/skillCategories/{id}
systemSkillCategoriesIdPatch PATCH /system/skillCategories/{id}
systemSkillCategoriesIdPut PUT /system/skillCategories/{id}
systemSkillCategoriesPost POST /system/skillCategories

systemSkillCategoriesCountGet

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

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

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

systemSkillCategoriesGet

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

Get Skill Categories

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

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]

systemSkillCategoriesIdDelete

systemSkillCategoriesIdDelete($id)

Delete Skill Category 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\SkillCategoriesApi();
$id = 56; // int | 

try {
    $api_instance->systemSkillCategoriesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling SkillCategoriesApi->systemSkillCategoriesIdDelete: ', $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]

systemSkillCategoriesIdGet

\Spinen\ConnectWise\Clients\System\Model\SkillCategory systemSkillCategoriesIdGet($id)

Get Skill Category 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\SkillCategoriesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\SkillCategory

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]

systemSkillCategoriesIdPatch

\Spinen\ConnectWise\Clients\System\Model\SkillCategory systemSkillCategoriesIdPatch($id, $operations)

Update Skill Category

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

try {
    $result = $api_instance->systemSkillCategoriesIdPatch($id, $operations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SkillCategoriesApi->systemSkillCategoriesIdPatch: ', $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\SkillCategory

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]

systemSkillCategoriesIdPut

\Spinen\ConnectWise\Clients\System\Model\SkillCategory systemSkillCategoriesIdPut($id, $skill_category)

Replace Skill Category

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

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

Parameters

Name Type Description Notes
id int
skill_category \Spinen\ConnectWise\Clients\System\Model\SkillCategory

Return type

\Spinen\ConnectWise\Clients\System\Model\SkillCategory

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]

systemSkillCategoriesPost

\Spinen\ConnectWise\Clients\System\Model\SkillCategory systemSkillCategoriesPost($skill_category)

Create Skill Category

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\SkillCategoriesApi();
$skill_category = new \Spinen\ConnectWise\Clients\System\Model\SkillCategory(); // \Spinen\ConnectWise\Clients\System\Model\SkillCategory | 

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

Parameters

Name Type Description Notes
skill_category \Spinen\ConnectWise\Clients\System\Model\SkillCategory

Return type

\Spinen\ConnectWise\Clients\System\Model\SkillCategory

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]