Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 13.9 KB

SubCategoriesApi.md

File metadata and controls

386 lines (263 loc) · 13.9 KB
Raw

Spinen\ConnectWise\Clients\Procurement\SubCategoriesApi

Spinen's PHP ConnectWise Client for Procurement 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
procurementCategoriesIdSubcategoriesCountGet GET /procurement/categories/{id}/subcategories/count
procurementCategoriesIdSubcategoriesGet GET /procurement/categories/{id}/subcategories
procurementCategoriesIdSubcategoriesPost POST /procurement/categories/{id}/subcategories
procurementCategoriesIdSubcategoriesSubcategoryIDDelete DELETE /procurement/categories/{id}/subcategories/{subcategoryID}
procurementCategoriesIdSubcategoriesSubcategoryIDGet GET /procurement/categories/{id}/subcategories/{subcategoryID}
procurementCategoriesIdSubcategoriesSubcategoryIDPatch PATCH /procurement/categories/{id}/subcategories/{subcategoryID}
procurementCategoriesIdSubcategoriesSubcategoryIDPut PUT /procurement/categories/{id}/subcategories/{subcategoryID}

procurementCategoriesIdSubcategoriesCountGet

\Spinen\ConnectWise\Clients\Procurement\Model\Count procurementCategoriesIdSubcategoriesCountGet($id, $conditions)

Get Sub Categories Count

Example

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

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

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

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

Parameters

Name Type Description Notes
id int
conditions string [optional]

Return type

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

procurementCategoriesIdSubcategoriesGet

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory[] procurementCategoriesIdSubcategoriesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Sub Categories

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$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->procurementCategoriesIdSubcategoriesGet($id, $conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubCategoriesApi->procurementCategoriesIdSubcategoriesGet: ', $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\Procurement\Model\SubCategory[]

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]

procurementCategoriesIdSubcategoriesPost

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory procurementCategoriesIdSubcategoriesPost($id, $sub_category)

Create Sub Category

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$id = 56; // int | 
$sub_category = new \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory(); // \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory | 

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

Parameters

Name Type Description Notes
id int
sub_category \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

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]

procurementCategoriesIdSubcategoriesSubcategoryIDDelete

procurementCategoriesIdSubcategoriesSubcategoryIDDelete($id, $subcategory_id)

Delete Sub Category By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$id = 56; // int | 
$subcategory_id = 56; // int | 

try {
    $api_instance->procurementCategoriesIdSubcategoriesSubcategoryIDDelete($id, $subcategory_id);
} catch (Exception $e) {
    echo 'Exception when calling SubCategoriesApi->procurementCategoriesIdSubcategoriesSubcategoryIDDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

procurementCategoriesIdSubcategoriesSubcategoryIDGet

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory procurementCategoriesIdSubcategoriesSubcategoryIDGet($id, $subcategory_id)

Get Sub Category By Id

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$id = 56; // int | 
$subcategory_id = 56; // int | 

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

Parameters

Name Type Description Notes
id int
subcategory_id int

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

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]

procurementCategoriesIdSubcategoriesSubcategoryIDPatch

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory procurementCategoriesIdSubcategoriesSubcategoryIDPatch($id, $subcategory_id, $operations)

Update Sub Category

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$id = 56; // int | 
$subcategory_id = 56; // int | 
$operations = array(new PatchOperation()); // \Spinen\ConnectWise\Clients\Procurement\Model\PatchOperation[] | 

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

Parameters

Name Type Description Notes
id int
subcategory_id int
operations \Spinen\ConnectWise\Clients\Procurement\Model\PatchOperation[]

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

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]

procurementCategoriesIdSubcategoriesSubcategoryIDPut

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory procurementCategoriesIdSubcategoriesSubcategoryIDPut($id, $subcategory_id, $sub_category)

Replace Sub Category

Example

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

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

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\SubCategoriesApi();
$id = 56; // int | 
$subcategory_id = 56; // int | 
$sub_category = new \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory(); // \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory | 

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

Parameters

Name Type Description Notes
id int
subcategory_id int
sub_category \Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

Return type

\Spinen\ConnectWise\Clients\Procurement\Model\SubCategory

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]