Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.9 KB

ScheduleEntriesApi.md

File metadata and controls

372 lines (249 loc) · 11.9 KB

Spinen\ConnectWise\Clients\Schedule\ScheduleEntriesApi

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
scheduleEntriesCountGet GET /schedule/entries/count
scheduleEntriesGet GET /schedule/entries
scheduleEntriesIdDelete DELETE /schedule/entries/{id}
scheduleEntriesIdGet GET /schedule/entries/{id}
scheduleEntriesIdPatch PATCH /schedule/entries/{id}
scheduleEntriesIdPut PUT /schedule/entries/{id}
scheduleEntriesPost POST /schedule/entries

scheduleEntriesCountGet

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

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

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

scheduleEntriesGet

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

Get Schedules

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

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]

scheduleEntriesIdDelete

scheduleEntriesIdDelete($id)

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

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

scheduleEntriesIdGet

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry scheduleEntriesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry

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]

scheduleEntriesIdPatch

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry scheduleEntriesIdPatch($id, $operations)

Update Schedule

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

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

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]

scheduleEntriesIdPut

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry scheduleEntriesIdPut($id, $schedule_entry)

Replace Schedule

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\ScheduleEntriesApi();
$id = 56; // int | 
$schedule_entry = new \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry(); // \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry | 

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

Parameters

Name Type Description Notes
id int
schedule_entry \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry

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]

scheduleEntriesPost

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry scheduleEntriesPost($schedule_entry)

Create Schedule

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\ScheduleEntriesApi();
$schedule_entry = new \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry(); // \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry | 

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

Parameters

Name Type Description Notes
schedule_entry \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleEntry

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]