3 * Test Generated example of using relationship get API
4 * demonstrates use of NOT IN filter *
6 function relationship_get_example(){
8 'relationship_type_id' => array(
17 $result = civicrm_api3('relationship', 'get', $params);
19 catch (CiviCRM_API3_Exception
$e) {
21 $errorMessage = $e->getMessage();
22 $errorCode = $e->getErrorCode();
23 $errorData = $e->getExtraParams();
24 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
31 * Function returns array of result expected from previous function
33 function relationship_get_expectedresult(){
35 $expectedResult = array(
42 'contact_id_a' => '87',
43 'contact_id_b' => '89',
44 'relationship_type_id' => '32',
45 'start_date' => '2013-07-29 00:00:00',
48 'is_permission_a_b' => 0,
49 'is_permission_b_a' => 0,
53 'contact_id_a' => '87',
54 'contact_id_b' => '89',
55 'relationship_type_id' => '35',
56 'start_date' => '2013-07-29 00:00:00',
59 'is_permission_a_b' => 0,
60 'is_permission_b_a' => 0,
65 return $expectedResult;
70 * This example has been generated from the API test suite. The test that created it is called
72 * testGetTypeOperators and can be found in
73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
75 * You can see the outcome of the API tests at
76 * https://test.civicrm.org/job/CiviCRM-master-git/
78 * To Learn about the API read
79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
81 * Browse the api on your own site with the api explorer
82 * http://MYSITE.ORG/path/to/civicrm/api/explorer
84 * Read more about testing here
85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
87 * API Standards documentation:
88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards