custom data in API v2

[dalin]

I can't seem to find any documentation or examples (in the wiki or the simpletests) of how to get custom data for contacts.  Does this functionality still exist?  If so I can add it to the wiki.

[Dave Greenberg]

Dave - we're working on adding some example(s) for this to SVN. Will post back here when they're up there - and then will take u up on your offer to add to the wiki doc :-)

[dalin]

I don't necessarily need examples.  Just point me in the right direction and I'll figure it out.  Here's my guess though which I'll try this morning:

$params = array(
  'country' => 'US',
  'state_province' => 'CA',
  'return.display_name' => 1
  'return.custom_mycustomfield' => 1,
);
$result = civicrm_contact_search( $params );

[dalin]

Nope I tried several variations on that theme with no luck. 

[dalin]

Got it:

    require_once('api/v2/Contact.php');
    $params = array(
      'contact_id' => $cid,
      'return.first_name' => 1,
      'return.last_name' => 1,
      'return.state_province' => 1,
      'return.custom_2' => 1,
    );
    $contact = civicrm_contact_search($params);

[Manish Zope]

Sorry for the delayed reply..

Here is the test case using Contact v2 API (which sets/gets custom data)

http://svn.civicrm.org/civicrm/branches/v2.0/test-new/SimpleTest/api-v2/ContactAddWithCustomData.php

Manish

[dalin]

Hey Manish,
Thanks for the example code.  I'm looking through your unit test and I see two issues:

Code: [Select]

$this->assertEqual( $getContact['custom_5'],   $params['custom_5']   );
custom_5 was never defined, so you're asserting that null == null

Also you haven't created the custom fields before the test and destoroyed them afterward, you're assuming that they're already there.  This makes the test easily breakable. 

[Chris Burgess]

Reading Manish's code, I had figured that NULL = NULL assertion was intentional, to demonstrate that a custom value which was never set will be equal to an uninitialised variable.

However, I did have trouble using the same example code to UPDATE (not INSERT) custom data. I posted about this in a separate thread.

Dave, as you're working on making your code work with 2.x, please add any notes that might be useful to others migrating either to this forum thread:

http://forum.civicrm.org/index.php/topic,3008.msg13156.html

Or this wiki page:

http://wiki.civicrm.org/confluence/display/CRMDOC/Migrating+from+1.x+API+to+2.x+API

[Manish Zope]

Check the modified test case
http://fisheye.civicrm.org/browse/CiviCRM/branches/v2.0/test-new/SimpleTest/api-v2/ContactAddWithCustomData.php?r=13903

Code: [Select]

$this->assertEqual( $getContact['custom_5'],   $params['custom_5']   );custom_5 was never defined, so you're asserting that null == null

[ijames]

I'm running into the same problem with trying to set custom data. 

How does one run the test code provided?

Thanks!

James

[Chris Burgess]

Hi ljames

If you want to run the SimpleTest api-v2/LocationGet.php, then you'd use this URL.

http://localhost/drupal/sites/all/modules/civicrm/test-new/SimpleTest/OneTest.php?q=api-v2/LocationGet

My dev server is "localhost" and the path to the CiviCRM code is "/drupal/sites/all/modules/civicrm/" - those values may be different for you. Also, don't forget to remove the ".php" from the end of the ?q= parameter.

Docs: http://wiki.civicrm.org/confluence/display/CRM/Writing+SimpleTest+unit+tests