Skip to content

Latest commit

 

History

History
372 lines (249 loc) · 11.5 KB

SurveysApi.md

File metadata and controls

372 lines (249 loc) · 11.5 KB
Raw

Spinen\ConnectWise\Clients\Service\SurveysApi

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
serviceSurveysCountGet GET /service/surveys/count
serviceSurveysGet GET /service/surveys
serviceSurveysIdDelete DELETE /service/surveys/{id}
serviceSurveysIdGet GET /service/surveys/{id}
serviceSurveysIdPatch PATCH /service/surveys/{id}
serviceSurveysIdPut PUT /service/surveys/{id}
serviceSurveysPost POST /service/surveys

serviceSurveysCountGet

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

Get Surveys 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\SurveysApi();
$conditions = "conditions_example"; // string | 

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

serviceSurveysGet

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

Get Surveys

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

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]

serviceSurveysIdDelete

serviceSurveysIdDelete($id)

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

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

serviceSurveysIdGet

\Spinen\ConnectWise\Clients\Service\Model\Survey serviceSurveysIdGet($id)

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

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

Parameters

Name Type Description Notes
id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\Survey

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]

serviceSurveysIdPatch

\Spinen\ConnectWise\Clients\Service\Model\Survey serviceSurveysIdPatch($id, $operations)

Update Survey

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

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

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]

serviceSurveysIdPut

\Spinen\ConnectWise\Clients\Service\Model\Survey serviceSurveysIdPut($id, $survey)

Replace Survey

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\Survey

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]

serviceSurveysPost

\Spinen\ConnectWise\Clients\Service\Model\Survey serviceSurveysPost($survey)

Create Survey

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\SurveysApi();
$survey = new \Spinen\ConnectWise\Clients\Service\Model\Survey(); // \Spinen\ConnectWise\Clients\Service\Model\Survey | 

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

Parameters

Name Type Description Notes
survey \Spinen\ConnectWise\Clients\Service\Model\Survey

Return type

\Spinen\ConnectWise\Clients\Service\Model\Survey

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]