Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.8 KB

InOutBoardsApi.md

File metadata and controls

372 lines (249 loc) · 11.8 KB
Raw

Spinen\ConnectWise\Clients\System\InOutBoardsApi

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
systemInOutBoardsCountGet GET /system/inOutBoards/count
systemInOutBoardsGet GET /system/inOutBoards
systemInOutBoardsIdDelete DELETE /system/inOutBoards/{id}
systemInOutBoardsIdGet GET /system/inOutBoards/{id}
systemInOutBoardsIdPatch PATCH /system/inOutBoards/{id}
systemInOutBoardsIdPut PUT /system/inOutBoards/{id}
systemInOutBoardsPost POST /system/inOutBoards

systemInOutBoardsCountGet

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

Get In Out Board 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\InOutBoardsApi();
$conditions = "conditions_example"; // string | 

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

systemInOutBoardsGet

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

Get In Out Board

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

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]

systemInOutBoardsIdDelete

systemInOutBoardsIdDelete($id)

Delete In Out Board 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\InOutBoardsApi();
$id = 56; // int | 

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

systemInOutBoardsIdGet

\Spinen\ConnectWise\Clients\System\Model\InOutBoard systemInOutBoardsIdGet($id)

Get In Out Board 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\InOutBoardsApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutBoard

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]

systemInOutBoardsIdPatch

\Spinen\ConnectWise\Clients\System\Model\InOutBoard systemInOutBoardsIdPatch($id, $operations)

Update In Out Board

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

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

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]

systemInOutBoardsIdPut

\Spinen\ConnectWise\Clients\System\Model\InOutBoard systemInOutBoardsIdPut($id, $in_out_board)

Replace In Out Board

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

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

Parameters

Name Type Description Notes
id int
in_out_board \Spinen\ConnectWise\Clients\System\Model\InOutBoard

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutBoard

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]

systemInOutBoardsPost

\Spinen\ConnectWise\Clients\System\Model\InOutBoard systemInOutBoardsPost($in_out_board)

Create In Out Board

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\InOutBoardsApi();
$in_out_board = new \Spinen\ConnectWise\Clients\System\Model\InOutBoard(); // \Spinen\ConnectWise\Clients\System\Model\InOutBoard | 

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

Parameters

Name Type Description Notes
in_out_board \Spinen\ConnectWise\Clients\System\Model\InOutBoard

Return type

\Spinen\ConnectWise\Clients\System\Model\InOutBoard

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]