Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 12.1 KB

ScheduleStatusesApi.md

File metadata and controls

372 lines (249 loc) · 12.1 KB

Spinen\ConnectWise\Clients\Schedule\ScheduleStatusesApi

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
scheduleStatusesCountGet GET /schedule/statuses/count
scheduleStatusesGet GET /schedule/statuses
scheduleStatusesIdDelete DELETE /schedule/statuses/{id}
scheduleStatusesIdGet GET /schedule/statuses/{id}
scheduleStatusesIdPatch PATCH /schedule/statuses/{id}
scheduleStatusesIdPut PUT /schedule/statuses/{id}
scheduleStatusesPost POST /schedule/statuses

scheduleStatusesCountGet

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

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

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

scheduleStatusesGet

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

Get Schedule Statuses

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

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]

scheduleStatusesIdDelete

scheduleStatusesIdDelete($id)

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

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

scheduleStatusesIdGet

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus scheduleStatusesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus

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]

scheduleStatusesIdPatch

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus scheduleStatusesIdPatch($id, $operations)

Update Schedule Status

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

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

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]

scheduleStatusesIdPut

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus scheduleStatusesIdPut($id, $schedule_status)

Replace Schedule Status

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

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

Parameters

Name Type Description Notes
id int
schedule_status \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus

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]

scheduleStatusesPost

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus scheduleStatusesPost($schedule_status)

Create Schedule Status

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\ScheduleStatusesApi();
$schedule_status = new \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus(); // \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus | 

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

Parameters

Name Type Description Notes
schedule_status \Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus

Return type

\Spinen\ConnectWise\Clients\Schedule\Model\ScheduleStatus

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]