Merge pull request #10087 from lcdservices/CRM-20368
[civicrm-core.git] / api / v3 / examples / Contact / FormatSingleValue.php
index 587b621c2f6959175509fd6584bf9af96f016d7d..49d52becc1b09f9dd70fffe023c5acdf0d55441a 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Test Generated example of using contact getvalue API.
+ * Test Generated example demonstrating the Contact.getvalue API.
  *
  * This demonstrates use of the 'format.single_value' param.
  * This param causes only a single value of the only entity to be returned as an string.
@@ -16,7 +16,7 @@ function contact_getvalue_example() {
   );
 
   try{
-    $result = civicrm_api3('contact', 'getvalue', $params);
+    $result = civicrm_api3('Contact', 'getvalue', $params);
   }
   catch (CiviCRM_API3_Exception $e) {
     // Handle error here.
@@ -24,7 +24,8 @@ function contact_getvalue_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -46,11 +47,10 @@ function contact_getvalue_expectedresult() {
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testContactGetFormatSingleValue
-* and can be found in
+* The test that created it is called "testContactGetFormatSingleValue"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
 *
 * You can see the outcome of the API tests at