Spinen\ConnectWise\Clients\Service\BoardTypesApi

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
serviceBoardsIdTypesCountGet	GET /service/boards/{id}/types/count
serviceBoardsIdTypesGet	GET /service/boards/{id}/types
serviceBoardsIdTypesPost	POST /service/boards/{id}/types
serviceBoardsIdTypesTypeIdDelete	DELETE /service/boards/{id}/types/{typeId}
serviceBoardsIdTypesTypeIdGet	GET /service/boards/{id}/types/{typeId}
serviceBoardsIdTypesTypeIdPatch	PATCH /service/boards/{id}/types/{typeId}
serviceBoardsIdTypesTypeIdPut	PUT /service/boards/{id}/types/{typeId}
serviceBoardsIdTypesTypeIdSubTypeAssociationGet	GET /service/boards/{id}/types/{typeId}/subTypeAssociation

serviceBoardsIdTypesCountGet

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

Get Types 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\BoardTypesApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

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

serviceBoardsIdTypesGet

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

Get Types

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\BoardTypesApi();
$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->serviceBoardsIdTypesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardTypesApi->serviceBoardsIdTypesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	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\Type[]

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]

serviceBoardsIdTypesPost

\Spinen\ConnectWise\Clients\Service\Model\Type serviceBoardsIdTypesPost($id, $type)

Create Type

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\BoardTypesApi();
$id = 56; // int | 
$type = new \Spinen\ConnectWise\Clients\Service\Model\Type(); // \Spinen\ConnectWise\Clients\Service\Model\Type | 

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Type

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]

serviceBoardsIdTypesTypeIdDelete

serviceBoardsIdTypesTypeIdDelete($id, $type_id)

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

try {
    $api_instance->serviceBoardsIdTypesTypeIdDelete($id, $type_id);
} catch (Exception $e) {
    echo 'Exception when calling BoardTypesApi->serviceBoardsIdTypesTypeIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

serviceBoardsIdTypesTypeIdGet

\Spinen\ConnectWise\Clients\Service\Model\Type serviceBoardsIdTypesTypeIdGet($id, $type_id)

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

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

Parameters

Name	Type	Description	Notes
id	int
type_id	int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Type

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]

serviceBoardsIdTypesTypeIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Type serviceBoardsIdTypesTypeIdPatch($id, $type_id, $operations)

Update Types

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Type

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]

serviceBoardsIdTypesTypeIdPut

\Spinen\ConnectWise\Clients\Service\Model\Type serviceBoardsIdTypesTypeIdPut($id, $type_id, $type)

Replace Types

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\BoardTypesApi();
$id = 56; // int | 
$type_id = 56; // int | 
$type = new \Spinen\ConnectWise\Clients\Service\Model\Type(); // \Spinen\ConnectWise\Clients\Service\Model\Type | 

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

Parameters

Name	Type	Description	Notes
id	int
type_id	int
type	\Spinen\ConnectWise\Clients\Service\Model\Type

Return type

\Spinen\ConnectWise\Clients\Service\Model\Type

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]

serviceBoardsIdTypesTypeIdSubTypeAssociationGet

int serviceBoardsIdTypesTypeIdSubTypeAssociationGet($id, $type_id)

Get Sub Type Association

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\BoardTypesApi();
$id = 56; // int | 
$type_id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int
type_id	int

Return type

int

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]

Files

BoardTypesApi.md

Latest commit

History

BoardTypesApi.md

File metadata and controls

Spinen\ConnectWise\Clients\Service\BoardTypesApi

serviceBoardsIdTypesCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesGet

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesPost

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesTypeIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesTypeIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesTypeIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesTypeIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

serviceBoardsIdTypesTypeIdSubTypeAssociationGet

Example

Parameters

Return type

Authorization

HTTP request headers