api/v3/examples/Survey/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using survey get API
   4  * *
   5  */
   6 function survey_get_example(){
   7 $params = array(
   8   'title' => 'survey title',
   9   'activity_type_id' => '35',
  10   'max_number_of_contacts' => 12,
  11   'instructions' => 'Call people, ask for money',
  12 );
  13
  14 try{
  15   $result = civicrm_api3('survey', 'get', $params);
  16 }
  17 catch (CiviCRM_API3_Exception $e) {
  18   // handle error here
  19   $errorMessage = $e->getMessage();
  20   $errorCode = $e->getErrorCode();
  21   $errorData = $e->getExtraParams();
  22   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function survey_get_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 1,
  38   'values' => array(
  39       '1' => array(
  40           'id' => '1',
  41           'title' => 'survey title',
  42           'activity_type_id' => '35',
  43           'instructions' => 'Call people, ask for money',
  44           'max_number_of_contacts' => '12',
  45           'is_active' => '1',
  46           'is_default' => 0,
  47           'created_date' => '2013-07-28 08:49:19',
  48           'bypass_confirm' => 0,
  49           'is_share' => '1',
  50         ),
  51     ),
  52 );
  53
  54   return $expectedResult;
  55 }
  56
  57
  58 /*
  59 * This example has been generated from the API test suite. The test that created it is called
  60 *
  61 * testGetSurvey and can be found in
  62 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php
  63 *
  64 * You can see the outcome of the API tests at
  65 * https://test.civicrm.org/job/CiviCRM-master-git/
  66 *
  67 * To Learn about the API read
  68 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  69 *
  70 * Browse the api on your own site with the api explorer
  71 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  72 *
  73 * Read more about testing here
  74 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  75 *
  76 * API Standards documentation:
  77 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  78 */