Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.8 KB

BoardSubTypesApi.md

File metadata and controls

386 lines (263 loc) · 12.8 KB

Spinen\ConnectWise\Clients\Service\BoardSubTypesApi

Spinen's PHP ConnectWise Client for Service 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
serviceBoardsIdSubtypesCountGet GET /service/boards/{id}/subtypes/count
serviceBoardsIdSubtypesGet GET /service/boards/{id}/subtypes
serviceBoardsIdSubtypesPost POST /service/boards/{id}/subtypes
serviceBoardsIdSubtypesSubtypeIdDelete DELETE /service/boards/{id}/subtypes/{subtypeId}
serviceBoardsIdSubtypesSubtypeIdGet GET /service/boards/{id}/subtypes/{subtypeId}
serviceBoardsIdSubtypesSubtypeIdPatch PATCH /service/boards/{id}/subtypes/{subtypeId}
serviceBoardsIdSubtypesSubtypeIdPut PUT /service/boards/{id}/subtypes/{subtypeId}

serviceBoardsIdSubtypesCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count serviceBoardsIdSubtypesCountGet($id, $conditions)

Get Subtypes Count

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

Parameters

Name Type Description Notes
id int
conditions string [optional]

Return type

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

serviceBoardsIdSubtypesGet

\Spinen\ConnectWise\Clients\Service\Model\SubType[] serviceBoardsIdSubtypesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Subtypes

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$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->serviceBoardsIdSubtypesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardSubTypesApi->serviceBoardsIdSubtypesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
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\Service\Model\SubType[]

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]

serviceBoardsIdSubtypesPost

\Spinen\ConnectWise\Clients\Service\Model\SubType serviceBoardsIdSubtypesPost($id, $sub_type)

Create Subtype

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$sub_type = new \Spinen\ConnectWise\Clients\Service\Model\SubType(); // \Spinen\ConnectWise\Clients\Service\Model\SubType | 

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

Parameters

Name Type Description Notes
id int
sub_type \Spinen\ConnectWise\Clients\Service\Model\SubType

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubType

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]

serviceBoardsIdSubtypesSubtypeIdDelete

serviceBoardsIdSubtypesSubtypeIdDelete($id, $subtype_id)

Delete Subtype By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$subtype_id = 56; // int | 

try {
    $api_instance->serviceBoardsIdSubtypesSubtypeIdDelete($id, $subtype_id);
} catch (Exception $e) {
    echo 'Exception when calling BoardSubTypesApi->serviceBoardsIdSubtypesSubtypeIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
subtype_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]

serviceBoardsIdSubtypesSubtypeIdGet

\Spinen\ConnectWise\Clients\Service\Model\SubType serviceBoardsIdSubtypesSubtypeIdGet($id, $subtype_id)

Get Subtype By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$subtype_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
subtype_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubType

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]

serviceBoardsIdSubtypesSubtypeIdPatch

\Spinen\ConnectWise\Clients\Service\Model\SubType serviceBoardsIdSubtypesSubtypeIdPatch($id, $subtype_id, $operations)

Update Subtype

Example

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

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

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubType

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]

serviceBoardsIdSubtypesSubtypeIdPut

\Spinen\ConnectWise\Clients\Service\Model\SubType serviceBoardsIdSubtypesSubtypeIdPut($id, $subtype_id, $sub_type)

Replace Subtype

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Service\Api\BoardSubTypesApi();
$id = 56; // int | 
$subtype_id = 56; // int | 
$sub_type = new \Spinen\ConnectWise\Clients\Service\Model\SubType(); // \Spinen\ConnectWise\Clients\Service\Model\SubType | 

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

Parameters

Name Type Description Notes
id int
subtype_id int
sub_type \Spinen\ConnectWise\Clients\Service\Model\SubType

Return type

\Spinen\ConnectWise\Clients\Service\Model\SubType

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]