CiviCRM Community Forums (archive)

Hi,

The behaviour is to return all relationships, both active and inactive. The BAO has an additional parameter status (eg 4 for only the active ones). Can I expose it in the api (and default to 0) ?

X+

Hi,

This is on the same function & sort of the same topic so I've added it to your thread...

My understanding is that the optimal api to call is the civicrm_relationship_get method. But I just can't figure out how you are supposed to know the valid keys to put in the array. The relationship methods seem to use a mix of 'contact_id' 'cid' contact_id_a'.

The alternative method  civicrm_contact_relationship_get has clear input parameters but I can't documented  anywhere where the options for the $params array that you pass to civicrm_relationship_get are outlined. I could go trawling through the code but I thought the point of the API was that you should be able to interact with the api without looking at the code behind it.

So once again - I think I just must be missing some obvious & fundamental piece of information that would make it clear to me how to interpret this easily. Specifically I was looking for what to call the key for the related contact.

e.g
$params['contact_id'] = 274;
$params['relationship_type_id']=4;
$outputParams= civicrm_relationship_get($params);
print_r($outputParams);

I know someone will give me the answer to what the key is called but my real question is how am I supposed to know what it is?

[quote]civicrm_relationship_get (line 217)

Function to get the relationship

    * return: of all relationship.
    * access: public

Array civicrm_relationship_get (array $params)

    * array $params: (reference ) input parameters[/quote]




civicrm_relationship_get (line 217)

Function to get the relationship

    * return: of all relationship.
    * access: public

Array civicrm_relationship_get (array $params)

    * array $params: (reference ) input parameters