api/v3/examples/SurveyGet.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         ),
  50     ),
  51 );
  52
  53   return $expectedResult;
  54 }
  55
  56
  57 /*
  58 * This example has been generated from the API test suite. The test that created it is called
  59 *
  60 * testGetSurvey and can be found in
  61 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SurveyTest.php
  62 *
  63 * You can see the outcome of the API tests at
  64 * http://tests.dev.civicrm.org/trunk/results-api_v3
  65 *
  66 * To Learn about the API read
  67 * http://book.civicrm.org/developer/current/techniques/api/
  68 *
  69 * and review the wiki at
  70 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  71 *
  72 * Read more about testing here
  73 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  74 *
  75 * API Standards documentation:
  76 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  77 */