Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.5 KB

SourcesApi.md

File metadata and controls

372 lines (249 loc) · 11.5 KB
Raw

Spinen\ConnectWise\Clients\Service\SourcesApi

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
serviceSourcesCountGet GET /service/sources/count
serviceSourcesGet GET /service/sources
serviceSourcesIdDelete DELETE /service/sources/{id}
serviceSourcesIdGet GET /service/sources/{id}
serviceSourcesIdPatch PATCH /service/sources/{id}
serviceSourcesIdPut PUT /service/sources/{id}
serviceSourcesPost POST /service/sources

serviceSourcesCountGet

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

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

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

serviceSourcesGet

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

Get Sources

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

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]

serviceSourcesIdDelete

serviceSourcesIdDelete($id)

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

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

serviceSourcesIdGet

\Spinen\ConnectWise\Clients\Service\Model\Source serviceSourcesIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Source

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]

serviceSourcesIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Source serviceSourcesIdPatch($id, $operations)

Update Source

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

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

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]

serviceSourcesIdPut

\Spinen\ConnectWise\Clients\Service\Model\Source serviceSourcesIdPut($id, $source)

Replace Source

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Source

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]

serviceSourcesPost

\Spinen\ConnectWise\Clients\Service\Model\Source serviceSourcesPost($source)

Create Source

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\SourcesApi();
$source = new \Spinen\ConnectWise\Clients\Service\Model\Source(); // \Spinen\ConnectWise\Clients\Service\Model\Source | 

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

Parameters

Name Type Description Notes
source \Spinen\ConnectWise\Clients\Service\Model\Source

Return type

\Spinen\ConnectWise\Clients\Service\Model\Source

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]