Skip to content

Latest commit

 

History

History
273 lines (184 loc) · 9.31 KB

ScheduleReminderTimesApi.md

File metadata and controls

273 lines (184 loc) · 9.31 KB

Spinen\ConnectWise\Clients\Schedule\ScheduleReminderTimesApi

Spinen's PHP ConnectWise Client for Schedule 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
scheduleReminderTimesCountGet GET /schedule/reminderTimes/count
scheduleReminderTimesGet GET /schedule/reminderTimes
scheduleReminderTimesIdGet GET /schedule/reminderTimes/{id}
scheduleReminderTimesIdPatch PATCH /schedule/reminderTimes/{id}
scheduleReminderTimesIdPut PUT /schedule/reminderTimes/{id}

scheduleReminderTimesCountGet

\Spinen\ConnectWise\Clients\Schedule\Model\Count scheduleReminderTimesCountGet($conditions)

Get Reminder Time Count

Example

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

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

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

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

Parameters

Name Type Description Notes
conditions string [optional]

Return type

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

scheduleReminderTimesGet

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime[] scheduleReminderTimesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Reminder Time

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Schedule\Api\ScheduleReminderTimesApi();
$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->scheduleReminderTimesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleReminderTimesApi->scheduleReminderTimesGet: ', $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\Schedule\Model\ScheduleReminderTime[]

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]

scheduleReminderTimesIdGet

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime scheduleReminderTimesIdGet($id)

Get Reminder Time By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Schedule\Api\ScheduleReminderTimesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime

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]

scheduleReminderTimesIdPatch

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime scheduleReminderTimesIdPatch($id, $operations)

Update Reminder Time

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Schedule\Api\ScheduleReminderTimesApi();
$id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Schedule\Model\PatchOperation[] | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime

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]

scheduleReminderTimesIdPut

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime scheduleReminderTimesIdPut($id, $reminder_time)

Replace Reminder Time

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Schedule\Api\ScheduleReminderTimesApi();
$id = 56; // int | 
$reminder_time = new \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime(); // \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime | 

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

Parameters

Name Type Description Notes
id int
reminder_time \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleReminderTime

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]