API - pass in custom field as criteria

[Eileen]

Hi there,

Is it possible to pass in a custom field as a criteria for the contact_get api. I have been playing with the example in Xavier's blog and had some success but I'm not sure if I can pass in a custom field - and if so what the format is. Using a whole swag of smart groups isn't practical for one of the scenarios I am looking at.

{crmAPI entity='contact' action="search" var="contacts" rowCount="10" contact_type="Individual" custom_15="1" group="26" json="1" return ="sort_name, custom_15, group"}
<ul>
{foreach from=$contacts item=contact}
<li id="contact_{$contact.contact_id}">{$contact.sort_name}</li>
<li id="group">{$contact.custom_15}</li>

{/foreach}
</ul>

NB - I do get this error on my 3.0 test site with the above code -even if I take out the references to custom_15 and the rather optimistic reference to json="1" ( I was hopeful I might be able to get it back in that format if I passed that in)

[Kiran Jagtap]

there was minor bug, which is fixed in r23239

might want to take a look for patch : http://fisheye.civicrm.org/changelog/CiviCRM?cs=23239

kiran

[Eileen]

So, that's the answer to the 'NB'? But is there an answer to the original question?

[Donald Lobo]

you might want to do this as a php code snippet  and get it to work. all custom fields that are marked searchable can be used in contact_get / contact_search

lobo

[Eileen]

OK - you mean post on the wiki?  - Am I correct about the format::

custom_15

[Donald Lobo]

no i meant, write a small php script and get it to work first using the api, and then try to migrate it to using the template call.

lobo

[Eileen]

I've mostly been testing them using the url method - i.e. the rest call but can try that

[Eileen]

Actually - my syntax was correct BUT when I checked to make sure the field was searchable I found I was using the group number not the field number. (ie. custom_15 should have been custom_69).

Anyway, great to realise this API allows searching by searchable fields and groups.

[xavier]

and tag, and...

As you're realised, that's a dumb wrapper around the api, whatever feature the api provides, crmAPI provides too.

I personally find easier to test using the REST wrapper:

http://example.org/civicrm/ajax/rest?fnName=civicrm/contact/search&group=2&contact_type=Individual&return[sort_name]=1&group=7&custom_42=douglas&rowCount=200&country=1134

See what I get that way