Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 12.9 KB

SurveyResultsApi.md

File metadata and controls

386 lines (263 loc) · 12.9 KB

Spinen\ConnectWise\Clients\Service\SurveyResultsApi

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
serviceSurveysIdResultsCountGet GET /service/surveys/{id}/results/count
serviceSurveysIdResultsGet GET /service/surveys/{id}/results
serviceSurveysIdResultsPost POST /service/surveys/{id}/results
serviceSurveysIdResultsResultIdDelete DELETE /service/surveys/{id}/results/{resultId}
serviceSurveysIdResultsResultIdGet GET /service/surveys/{id}/results/{resultId}
serviceSurveysIdResultsResultIdPatch PATCH /service/surveys/{id}/results/{resultId}
serviceSurveysIdResultsResultIdPut PUT /service/surveys/{id}/results/{resultId}

serviceSurveysIdResultsCountGet

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

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

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

serviceSurveysIdResultsGet

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

Get Survey Results

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

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]

serviceSurveysIdResultsPost

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult serviceSurveysIdResultsPost($id, $survey_result)

Create Survey Result

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult

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]

serviceSurveysIdResultsResultIdDelete

serviceSurveysIdResultsResultIdDelete($id, $result_id)

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

try {
    $api_instance->serviceSurveysIdResultsResultIdDelete($id, $result_id);
} catch (Exception $e) {
    echo 'Exception when calling SurveyResultsApi->serviceSurveysIdResultsResultIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

serviceSurveysIdResultsResultIdGet

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult serviceSurveysIdResultsResultIdGet($id, $result_id)

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

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

Parameters

Name Type Description Notes
id int
result_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult

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]

serviceSurveysIdResultsResultIdPatch

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult serviceSurveysIdResultsResultIdPatch($id, $result_id, $operations)

Update Survey Result

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult

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]

serviceSurveysIdResultsResultIdPut

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult serviceSurveysIdResultsResultIdPut($id, $result_id, $survey_result)

Replace Survey Result

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\SurveyResultsApi();
$id = 56; // int | 
$result_id = 56; // int | 
$survey_result = new \Spinen\ConnectWise\Clients\Service\Model\SurveyResult(); // \Spinen\ConnectWise\Clients\Service\Model\SurveyResult | 

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

Parameters

Name Type Description Notes
id int
result_id int
survey_result \Spinen\ConnectWise\Clients\Service\Model\SurveyResult

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyResult

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]