Merge pull request #1048 from eileenmcnaughton/master

[civicrm-core.git] / api / v3 / examples / MailingGroupSubscribe.php

<?php

/*
 
 */
function mailing_group_subscribe_example(){
$params = array(
  'email' => 'test@test.test',
  'group_id' => 2,
  'contact_id' => 3,
  'version' => 3,
  'hash' => 'b15de8b64e2cec34',
  'time_stamp' => '20101212121212',
);

  $result = civicrm_api( 'mailing_group','subscribe',$params );

  return $result;
}

/*
 * Function returns array of result expected from previous function
 */
function mailing_group_subscribe_expectedresult(){

  $expectedResult = array(
  'is_error' => 0,
  'version' => 3,
  'count' => 4,
  'values' => array(
      'contact_id' => '3',
      'subscribe_id' => '1',
      'hash' => '5b056fa32d2d56c6',
      'is_error' => 0,
    ),
);

  return $expectedResult  ;
}


/*
* This example has been generated from the API test suite. The test that created it is called
*
* testMailerGroupSubscribeGivenContactId and can be found in
* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MailingGroupTest.php
*
* You can see the outcome of the API tests at
* http://tests.dev.civicrm.org/trunk/results-api_v3
*
* To Learn about the API read
* http://book.civicrm.org/developer/current/techniques/api/
*
* and review the wiki at
* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/