Skip to content

Latest commit

 

History

History
425 lines (285 loc) · 13.3 KB

PrioritiesApi.md

File metadata and controls

425 lines (285 loc) · 13.3 KB

Spinen\ConnectWise\Clients\Service\PrioritiesApi

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
servicePrioritiesCountGet GET /service/priorities/count
servicePrioritiesGet GET /service/priorities
servicePrioritiesIdDelete DELETE /service/priorities/{id}
servicePrioritiesIdGet GET /service/priorities/{id}
servicePrioritiesIdImageGet GET /service/priorities/{id}/image
servicePrioritiesIdPatch PATCH /service/priorities/{id}
servicePrioritiesIdPut PUT /service/priorities/{id}
servicePrioritiesPost POST /service/priorities

servicePrioritiesCountGet

\Spinen\ConnectWise\Clients\Service\Model\Count servicePrioritiesCountGet($conditions)

Create Priorities 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\PrioritiesApi();
$conditions = "conditions_example"; // string | 

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

Parameters

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

servicePrioritiesGet

\Spinen\ConnectWise\Clients\Service\Model\Priority[] servicePrioritiesGet($conditions, $order_by, $childconditions, $customfieldconditions, $page, $page_size)

Get Priorities

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

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]

servicePrioritiesIdDelete

servicePrioritiesIdDelete($id)

Delete Priority 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\PrioritiesApi();
$id = 56; // int | 

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

servicePrioritiesIdGet

\Spinen\ConnectWise\Clients\Service\Model\Priority servicePrioritiesIdGet($id)

Get Priority 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\PrioritiesApi();
$id = 56; // int | 

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Priority

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]

servicePrioritiesIdImageGet

servicePrioritiesIdImageGet($id, $use_default_flag, $last_modified)

Get Priority Image

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\PrioritiesApi();
$id = 56; // int | 
$use_default_flag = true; // bool | 
$last_modified = "last_modified_example"; // string | 

try {
    $api_instance->servicePrioritiesIdImageGet($id, $use_default_flag, $last_modified);
} catch (Exception $e) {
    echo 'Exception when calling PrioritiesApi->servicePrioritiesIdImageGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
use_default_flag bool [optional]
last_modified string [optional]

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

servicePrioritiesIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Priority servicePrioritiesIdPatch($id, $operations)

Update Priority

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Priority

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]

servicePrioritiesIdPut

\Spinen\ConnectWise\Clients\Service\Model\Priority servicePrioritiesIdPut($id, $priority)

Replace Priority

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Priority

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]

servicePrioritiesPost

\Spinen\ConnectWise\Clients\Service\Model\Priority servicePrioritiesPost($priority)

Create Priority

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\PrioritiesApi();
$priority = new \Spinen\ConnectWise\Clients\Service\Model\Priority(); // \Spinen\ConnectWise\Clients\Service\Model\Priority | 

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

Parameters

Name Type Description Notes
priority \Spinen\ConnectWise\Clients\Service\Model\Priority

Return type

\Spinen\ConnectWise\Clients\Service\Model\Priority

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]