3 * Test Generated example demonstrating the Relationship.get API.
5 * Demonstrates use of NOT IN filter.
10 function relationship_get_example() {
12 'relationship_type_id' => [
21 $result = civicrm_api3('Relationship', 'get', $params);
23 catch (CiviCRM_API3_Exception
$e) {
25 $errorMessage = $e->getMessage();
26 $errorCode = $e->getErrorCode();
27 $errorData = $e->getExtraParams();
30 'error_message' => $errorMessage,
31 'error_code' => $errorCode,
32 'error_data' => $errorData,
40 * Function returns array of result expected from previous function.
45 function relationship_get_expectedresult() {
54 'contact_id_a' => '99',
55 'contact_id_b' => '101',
56 'relationship_type_id' => '35',
57 'start_date' => '2013-07-29 00:00:00',
59 'is_permission_a_b' => 0,
60 'is_permission_b_a' => 0,
64 'contact_id_a' => '99',
65 'contact_id_b' => '101',
66 'relationship_type_id' => '38',
67 'start_date' => '2013-07-29 00:00:00',
69 'is_permission_a_b' => 0,
70 'is_permission_b_a' => 0,
75 return $expectedResult;
79 * This example has been generated from the API test suite.
80 * The test that created it is called "testGetTypeOperators"
81 * and can be found at:
82 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
84 * You can see the outcome of the API tests at
85 * https://test.civicrm.org/job/CiviCRM-master-git/
87 * To Learn about the API read
88 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
90 * Browse the api on your own site with the api explorer
91 * http://MYSITE.ORG/path/to/civicrm/api
93 * Read more about testing here
94 * http://wiki.civicrm.org/confluence/display/CRM/Testing
96 * API Standards documentation:
97 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards