Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.8 KB

ScheduleTypesApi.md

File metadata and controls

372 lines (249 loc) · 11.8 KB
Raw

Spinen\ConnectWise\Clients\Schedule\ScheduleTypesApi

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
scheduleTypesCountGet GET /schedule/types/count
scheduleTypesGet GET /schedule/types
scheduleTypesIdDelete DELETE /schedule/types/{id}
scheduleTypesIdGet GET /schedule/types/{id}
scheduleTypesIdPatch PATCH /schedule/types/{id}
scheduleTypesIdPut PUT /schedule/types/{id}
scheduleTypesPost POST /schedule/types

scheduleTypesCountGet

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

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

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

scheduleTypesGet

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

Get Schedule Types

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

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]

scheduleTypesIdDelete

scheduleTypesIdDelete($id)

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

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

scheduleTypesIdGet

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType scheduleTypesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType

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]

scheduleTypesIdPatch

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType scheduleTypesIdPatch($id, $operations)

Update Schedule Type

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

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

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]

scheduleTypesIdPut

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType scheduleTypesIdPut($id, $schedule_type)

Replace Schedule Type

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

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

Parameters

Name Type Description Notes
id int
schedule_type \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType

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]

scheduleTypesPost

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType scheduleTypesPost($schedule_type)

Create Schedule Type

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\ScheduleTypesApi();
$schedule_type = new \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType(); // \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType | 

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

Parameters

Name Type Description Notes
schedule_type \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleType

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]