Basic query about using api to return only certain fields

[alo]

Hi,

I am using the api code as follows;

$params = array( 'version'  => 3, 'options' => array('sort'=>' contact_id DESC', 'limit'=>10 ) );
$result = civicrm_api( 'Contact' , ' get' , $params );

this returns all the fields for contacts, but I just need the image_URL and display_name values. I know theres a 'return' param I can use, but I cannot find anywhere that states what format it is expecting the list of return fields. I tried adding them comma separated as below (and also as an array), but the entire dataset is still returned.

e.g
$params = array( 'version'  => 3, 'options' => array('sort'=>' contact_id DESC', 'limit'=>10,'return'=>'image_URL,contact_id' ) );
$result = civicrm_api( 'Contact' , ' get' , $params );

I'm sure this is a simple question - help much appreciated though!

Al.

[xavier]

Hi,

you put the return as part of the option, it should be a top level key.

BTW, we recommend using the newer civicrm_api3:

Code: [Select]

$params = array( 'options' => array('sort'=>' contact_id DESC', 'limit'=>10 ), return=> "image_URL" );
$result = civicrm_api3( 'Contact' , ' get' , $params );

The main difference is that if you have an error, it will throw and exception and crashes "cleanly" if you forget to handle the case properly instead of silently let you continue running the code.

[Coleman Watts]

xavier - I recently got burned by this also (putting "return" in the options array rather than at the top level). This seems silly, is there any reason not to support it as part of options, that seems to make more sense all-around.

[xavier]

I'm afraid the only reason it's at the top level is because it was there before the option was set.

You suggest we honor both the return and option=>return and obsolete the top level return?

X+

[Eileen]

That seems reasonable - there is a long tail of syntaxes supported for 'return' - but there are tests for all of them

[Coleman Watts]

You suggest we honor both the return and option=>return and obsolete the top level return?

This late in the api3 lifecycle I'm not sure we should obsolete anything, but yes I think it would make sense to support it as an option as well as the top level.

[Eileen]

lifecycle or deathspiral.....