New phone API w/ REST

[David L]

Trying to figure out how to use the new Phone API with REST, but having no luck. I can't find any real documentation on the Address, Email, Phone and Website APIs anywhere - even http://api.civicrm.org/v3/ only has the deprecated Location API instead of the new APIs.

What would the url be for the phone API?

/civicrm/extern/rest.php?q=civicrm/phone/add doesn't work, neither does phone/create

And what params can be passed?

[Eileen]

Try the api explorer for REST syntax

http://sandbox.civicrm.org/civicrm/ajax/doc#explorer & the examples directory for php stuff

http://svn.civicrm.org/civicrm/branches/v3.4/api/v3/examples

There is a new chained syntax that is only in svn at the moment which you can use for multiple actions

http://svn.civicrm.org/civicrm/branches/v3.4/api/v3/examples/ContactCreate.php

[David L]

The explorer is a little buggy, try selecting phone, all the available fields are listed as 'undefined' so you have no idea how to use the api

[Eileen]

You should just be able to add your variables to the string ie

function phone_create_example(){
$params = array(
  'contact_id' => 1,
  'location_type_id' => 6,
  'phone' => '021 512 755',
  'is_primary' => 1,
  'version' => 3,
);

= &contact_id=1&location_type_id=1 etc

[Erik Hommel]

Make sure you select v3 for Phone on the API explorer, and select 'getfields' with action. You will get a list of all the fields available in the Phone API.

[xavier]

Ahhh,

Just realised that getfields has been fixed and follow the api convention (putting under values) and that ajax/doc doesn't.

@David, could you create an issue and assign it to me, I'll fix for the next version.

X+

[David L]

Created the issue http://issues.civicrm.org/jira/browse/CRM-8232 but I cannot assign it to you, maybe I don't have permissions to do that.

There is major need for documentation on REST API v3.

The official documentation http://wiki.civicrm.org/confluence/display/CRMDOC40/REST+interface is still for v2

Personally I just spend two hours trying to get v3 to work for me with (non-AJAX) REST, all I kept getting was 'Unknown Function Invocation' errors, even when using URLs generated directly by the API explorer, so I just gave up and went back to v2 instead, which works.

[Erik Hommel]

I agree that documentation is required, and it would be really helpful if you would assist? I use v3 with the REST and do not get the problems with the function invocations, but I am sure Xavier, Eileen and I could assist you?

[xavier]

Could you try on the sandbox and post the urls you tried ?

X+

[xavier]

The explorer is a little buggy, try selecting phone, all the available fields are listed as 'undefined' so you have no idea how to use the api

Fixed, thx (to backport, copy in your install this file)
http://svn.civicrm.org/civicrm/branches/v3.4/templates/CRM/Core/AjaxDoc.tpl