CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site

This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • APIs and Hooks (Moderator: Donald Lobo) »
  • Improve the api explorer: any suggestion?
Pages: [1]

Author Topic: Improve the api explorer: any suggestion?  (Read 773 times)

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Improve the api explorer: any suggestion?
May 10, 2012, 11:16:52 pm
Hi,

Had a chat on irc, and it wasn't clear for the user that you could alter the query field in the api explorer to add extra params,
eg if you select entity contact & param get it runs

/civicrm/ajax/rest?entity=Contact&action=Get

and you can then add extra param
/civicrm/ajax/rest?entity=Contact&action=Get&contact_type=Individual&group=42 and see the result with these new filters

I realised that it's far from obvious that you can do it. Any idea to make it more obvious? or change in the interface in general?
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Erik Hommel

  • Forum Godess / God
  • I live on this forum
  • *****
  • Posts: 1773
  • Karma: 59
    • EE-atWork
  • CiviCRM version: all sorts
  • CMS version: Drupal
  • MySQL version: Ubuntu's latest LTS version
  • PHP version: Ubuntu's latest LTS version
Re: Improve the api explorer: any suggestion?
May 11, 2012, 12:22:02 am
Hmmm will think about this one. I sincerely love the API explorer and use it often, so I have become tunnelvisioned :-)
Consultant/project manager at EEatWork and CiviCooP (http://www.civicoop.org/)

adixon

  • I post frequently
  • ***
  • Posts: 314
  • Karma: 19
    • Blackfly Solutions
Re: Improve the api explorer: any suggestion?
May 11, 2012, 07:04:55 am
I thought it was reasonably intuitive and the manual parameter thing is a feature I use all the time.

It really is an excellent learning and prototyping tool.

The only thing that I'd love is a link to it from the civi admin menu (but maybe there already is one?).

Erik Hommel

  • Forum Godess / God
  • I live on this forum
  • *****
  • Posts: 1773
  • Karma: 59
    • EE-atWork
  • CiviCRM version: all sorts
  • CMS version: Drupal
  • MySQL version: Ubuntu's latest LTS version
  • PHP version: Ubuntu's latest LTS version
Re: Improve the api explorer: any suggestion?
May 11, 2012, 07:43:41 am
Yeah, that makes sense...and perhaps a link to the instruction blog Xavier recorded some time ago?
Consultant/project manager at EEatWork and CiviCooP (http://www.civicoop.org/)

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: Improve the api explorer: any suggestion?
May 12, 2012, 03:22:03 am
Not sure about a link from the admin  menu - people assume (reasonably) that they can't easily break things from the admin menu - you can do some pretty destructive things from API explorer.
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: Improve the api explorer: any suggestion?
May 12, 2012, 03:26:57 am
I'm not sure either, Andreas did mention he never remember the url for the civicrm api explorer, which I personally find not to hard to find under /civicrm/api/explorer ...

Probably at least put a warning that it might be destructive.
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • APIs and Hooks (Moderator: Donald Lobo) »
  • Improve the api explorer: any suggestion?

This forum was archived on 2017-11-26.