Permalink
Browse files

Added initial examples to the README file

  • Loading branch information...
1 parent 66cd5b9 commit 740e3fdf4b6741558f010c9736174fa31a725cfd David Coallier committed Apr 1, 2010
Showing with 72 additions and 0 deletions.
  1. +72 −0 README.md
View
@@ -0,0 +1,72 @@
+## Introduction
+This is the PHP API Wrapper that allows developers to access the Capsule CRM api using PHP
+
+## Examples
+
+Get a **party** by party id:
+
+ require_once 'Services/Capsule.php';
+
+ try {
+ $capsule = new Services_Capsule('appName', 'token');
+ $party = $capsule->party->get('partyId');
+ } catch (Services_Capsule_Exception $e) {
+ print_r($e);
+ }
+
+ print_r($party);
+
+Get all **party**:
+
+ require_once 'Services/Capsule.php';
+
+ try {
+ $capsule = new Services_Capsule('appName', 'token');
+ $parties = $capsule->party->getList();
+ } catch (Services_Capsule_Exception $e) {
+ print_r($e);
+ }
+
+ print_r($parties);
+
+Get a list of people in a **party**:
+
+ require_once 'Services/Capsule.php';
+
+ try {
+ $capsule = new Services_Capsule('appName', 'token');
+ $people = $capsule->party->people->getAll('partyId');
+ } catch (Services_Capsule_Exception $e) {
+ print_r($e);
+ }
+
+ print_r($people);
+
+
+Add a new history note to a **party**:
+
+ require_once 'Services/Capsule.php';
+
+ try {
+ $capsule = new Services_Capsule('appName', 'token');
+ $note = $capsule->party->history->addNote(
+ 'partyId', 'This is a test note.'
+ );
+ } catch (Services_Capsule_Exception $e) {
+ print_r($e);
+ }
+
+ var_dump($note); // This will be true if success
+
+Get a list of **opportunity**:
+
+ require_once 'Services/Capsule.php';
+
+ try {
+ $capsule = new Services_Capsule('appName', 'token');
+ $opps = $capsule->opportunity->getList();
+ } catch (Services_Capsule_Exception $e) {
+ print_r($e);
+ }
+
+ print_r($opps);

0 comments on commit 740e3fd

Please sign in to comment.