Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.8 KB

CallbacksApi.md

File metadata and controls

372 lines (249 loc) · 11.8 KB

Spinen\ConnectWise\Clients\System\CallbacksApi

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
systemCallbacksCountGet GET /system/callbacks/count
systemCallbacksGet GET /system/callbacks
systemCallbacksIdDelete DELETE /system/callbacks/{id}
systemCallbacksIdGet GET /system/callbacks/{id}
systemCallbacksIdPatch PATCH /system/callbacks/{id}
systemCallbacksIdPut PUT /system/callbacks/{id}
systemCallbacksPost POST /system/callbacks

systemCallbacksCountGet

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

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

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

systemCallbacksGet

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

Get Callback Entries

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

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]

systemCallbacksIdDelete

systemCallbacksIdDelete($id)

Delete Callback Entry 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\CallbacksApi();
$id = 56; // int | 

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

systemCallbacksIdGet

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry systemCallbacksIdGet($id)

Get Callback Entry 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\CallbacksApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry

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]

systemCallbacksIdPatch

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry systemCallbacksIdPatch($id, $operations)

Update Callback Entry

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

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

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]

systemCallbacksIdPut

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry systemCallbacksIdPut($id, $callback_entry)

Replace Callback Entry

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

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

Parameters

Name Type Description Notes
id int
callback_entry \Spinen\ConnectWise\Clients\System\Model\CallbackEntry

Return type

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry

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]

systemCallbacksPost

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry systemCallbacksPost($callback_entry)

Create Callback Entry

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\CallbacksApi();
$callback_entry = new \Spinen\ConnectWise\Clients\System\Model\CallbackEntry(); // \Spinen\ConnectWise\Clients\System\Model\CallbackEntry | 

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

Parameters

Name Type Description Notes
callback_entry \Spinen\ConnectWise\Clients\System\Model\CallbackEntry

Return type

\Spinen\ConnectWise\Clients\System\Model\CallbackEntry

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]