Skip to content

Latest commit

 

History

History
386 lines (263 loc) · 13.2 KB

SurveyQuestionsApi.md

File metadata and controls

386 lines (263 loc) · 13.2 KB
Raw

Spinen\ConnectWise\Clients\Service\SurveyQuestionsApi

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
serviceSurveysIdQuestionsCountGet GET /service/surveys/{id}/questions/count
serviceSurveysIdQuestionsGet GET /service/surveys/{id}/questions
serviceSurveysIdQuestionsPost POST /service/surveys/{id}/questions
serviceSurveysIdQuestionsQuestionIdDelete DELETE /service/surveys/{id}/questions/{questionId}
serviceSurveysIdQuestionsQuestionIdGet GET /service/surveys/{id}/questions/{questionId}
serviceSurveysIdQuestionsQuestionIdPatch PATCH /service/surveys/{id}/questions/{questionId}
serviceSurveysIdQuestionsQuestionIdPut PUT /service/surveys/{id}/questions/{questionId}

serviceSurveysIdQuestionsCountGet

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

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

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

serviceSurveysIdQuestionsGet

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

Get Survey Questions

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

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]

serviceSurveysIdQuestionsPost

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion serviceSurveysIdQuestionsPost($id, $survey_question)

Create Survey Question

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

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

Parameters

Name Type Description Notes
id int
survey_question \Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

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]

serviceSurveysIdQuestionsQuestionIdDelete

serviceSurveysIdQuestionsQuestionIdDelete($id, $question_id)

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

try {
    $api_instance->serviceSurveysIdQuestionsQuestionIdDelete($id, $question_id);
} catch (Exception $e) {
    echo 'Exception when calling SurveyQuestionsApi->serviceSurveysIdQuestionsQuestionIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

serviceSurveysIdQuestionsQuestionIdGet

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion serviceSurveysIdQuestionsQuestionIdGet($id, $question_id)

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

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

Parameters

Name Type Description Notes
id int
question_id int

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

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]

serviceSurveysIdQuestionsQuestionIdPatch

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion serviceSurveysIdQuestionsQuestionIdPatch($id, $question_id, $operations)

Update Survey Question

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

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

Parameters

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

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

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]

serviceSurveysIdQuestionsQuestionIdPut

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion serviceSurveysIdQuestionsQuestionIdPut($id, $question_id, $survey_question)

Replace Survey Question

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\SurveyQuestionsApi();
$id = 56; // int | 
$question_id = 56; // int | 
$survey_question = new \Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion(); // \Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion | 

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

Parameters

Name Type Description Notes
id int
question_id int
survey_question \Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

Return type

\Spinen\ConnectWise\Clients\Service\Model\SurveyQuestion

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]