| 1 | {* |
| 2 | +--------------------------------------------------------------------+ |
| 3 | | CiviCRM version 4.7 | |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | This file is a part of CiviCRM. | |
| 8 | | | |
| 9 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 10 | | under the terms of the GNU Affero General Public License | |
| 11 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 12 | | | |
| 13 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 14 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 16 | | See the GNU Affero General Public License for more details. | |
| 17 | | | |
| 18 | | You should have received a copy of the GNU Affero General Public | |
| 19 | | License and the CiviCRM Licensing Exception along | |
| 20 | | with this program; if not, contact CiviCRM LLC | |
| 21 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 22 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 23 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 24 | +--------------------------------------------------------------------+ |
| 25 | *} |
| 26 | {htxt id="param-name-title"} |
| 27 | {ts}Parameter Name{/ts} |
| 28 | {/htxt} |
| 29 | {htxt id="param-name"} |
| 30 | <p> |
| 31 | {ts}Choose a parameter from the list, or select "other" for manual entry.{/ts} |
| 32 | </p> |
| 33 | {/htxt} |
| 34 | |
| 35 | {htxt id="param-op-title"} |
| 36 | {ts}Operator{/ts} |
| 37 | {/htxt} |
| 38 | {htxt id="param-op"} |
| 39 | <p> |
| 40 | {ts}The default operator is equals (=), and is the only operator supported for "create" or "delete" actions.{/ts} |
| 41 | </p> |
| 42 | <p> |
| 43 | {ts}Some apis support a special syntax to allow other operators for "get" type actions. Choosing a different operator will automatically use this syntax, although it may not work with every api.{/ts} |
| 44 | </p> |
| 45 | {/htxt} |
| 46 | |
| 47 | {htxt id="param-value-title"} |
| 48 | {ts}Parameter Value{/ts} |
| 49 | {/htxt} |
| 50 | {htxt id="param-value"} |
| 51 | <p> |
| 52 | {ts}The following formats are accepted:{/ts} |
| 53 | <ul> |
| 54 | <li>{ts}Simple values such as numbers, true, false and null.{/ts}</li> |
| 55 | <li>{ts}Strings. You may include quotes around the string to ensure it's not interpreted otherwise, e.g. "false".{/ts}</li> |
| 56 | <li>{ts}Arrays in js format, e.g. [1, 2, 3, 'foo', 'bar', 'baz'].{/ts}</li> |
| 57 | <li>{ts}Associative arrays in js object format, e.g. {ldelim}first: "one", second: "two", third: 3{rdelim}.{/ts}</li> |
| 58 | <li>{ts}A comma-separated list will automatically be turned into an array for multivalue operations, or you can explicitly use the js array format above.{/ts}</li> |
| 59 | </ul> |
| 60 | </p> |
| 61 | {/htxt} |