Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.6 KB

TodayPageCategoriesApi.md

File metadata and controls

372 lines (249 loc) · 12.6 KB
Raw

Spinen\ConnectWise\Clients\System\TodayPageCategoriesApi

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
systemTodayPageCategoriesCountGet GET /system/todayPageCategories/count
systemTodayPageCategoriesGet GET /system/todayPageCategories
systemTodayPageCategoriesIdDelete DELETE /system/todayPageCategories/{id}
systemTodayPageCategoriesIdGet GET /system/todayPageCategories/{id}
systemTodayPageCategoriesIdPatch PATCH /system/todayPageCategories/{id}
systemTodayPageCategoriesIdPut PUT /system/todayPageCategories/{id}
systemTodayPageCategoriesPost POST /system/todayPageCategories

systemTodayPageCategoriesCountGet

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

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

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

systemTodayPageCategoriesGet

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

Get Today Page 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\TodayPageCategoriesApi();
$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->systemTodayPageCategoriesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TodayPageCategoriesApi->systemTodayPageCategoriesGet: ', $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\TodayPageCategory[]

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]

systemTodayPageCategoriesIdDelete

systemTodayPageCategoriesIdDelete($id)

Delete Today Page 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\TodayPageCategoriesApi();
$id = 56; // int | 

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

systemTodayPageCategoriesIdGet

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory systemTodayPageCategoriesIdGet($id)

Get Today Page 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\TodayPageCategoriesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory

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]

systemTodayPageCategoriesIdPatch

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory systemTodayPageCategoriesIdPatch($id, $operations)

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

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

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]

systemTodayPageCategoriesIdPut

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory systemTodayPageCategoriesIdPut($id, $today_page_category)

Replace Today Page 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\TodayPageCategoriesApi();
$id = 56; // int | 
$today_page_category = new \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory(); // \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory | 

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

Parameters

Name Type Description Notes
id int
today_page_category \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory

Return type

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory

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]

systemTodayPageCategoriesPost

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory systemTodayPageCategoriesPost($today_page_category)

Create Today Page 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\TodayPageCategoriesApi();
$today_page_category = new \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory(); // \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory | 

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

Parameters

Name Type Description Notes
today_page_category \Spinen\ConnectWise\Clients\System\Model\TodayPageCategory

Return type

\Spinen\ConnectWise\Clients\System\Model\TodayPageCategory

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]