Using the CiviCRM API in AJAX from a Drupal page

[JohnFF]

Hi gang,

How can we use the CiviCRM API in an AJAX call from a Drupal page?

We're trying to update the status of a relationship (active/inactive) when a button is clicked.

The doc I read says 'you might be able to, but it's not supported, tell us if you make it work'.

All help appreciated!

[Coleman Watts]

There are 2 ways I know of to make this work:
1) Easier: Include the civicrm js on your page by doing CRM_Core_Resources::singleton()->addCoreResources();, then you will have access to CRM.api().
2) Lighter Weight: Just ping the api yourself by doing jQuery.ajax(). Use the api explorer to help you construct the correct url (or just notice what url is being called via firebug when you run CRM.api)
Let me know how it goes (bonus points if you update the docs).

[JohnFF]

Thanks Coleman, that's great

[awasson]

I'm a little late to the game but I had a similar need a few weeks ago. From a Drupal page, I needed to create a relationship between one CiviCRM contact and another. In order to do so, I needed to load the CiviCRM jQuery API and I needed the CiviCRM Contact ID's and the ID number of the relationship I wanted to apply.

I used the API explorer to figure out the correct jQuery to make it work (www.example.com/civicrm/api/explorer)

Here is my proof of concept:

Note: I was using a View to show the relationships in a widget (block) and I made reference of that in my code below.
Contact A ID = 2
Contact B ID = 25
Relationship ID = 11

Code: [Select]


# USE PHP TO LOAD CORE JAVASCRIPT
<?php
    civicrm_initialize();
    $manager = CRM_Core_Resources::singleton();
    $manager->addCoreResources();
?>

<script>
// Javascript to create a relationship between Contact A & COntact B for Relationship Type = 11
CRM.api('Relationship', 'create', {'sequential': 1, 'contact_id_a': 2, 'contact_id_b': 25, 'relationship_type_id': 11},
  {success: function(data) {
      cj.each(data, function(key, value) {
        // Refresh the view here to show the updated information in the widget.
      });
    }
  }
);
</script>