Page tree
Skip to end of metadata
Go to start of metadata

b V4.7

Mit der Klasse addon_rest ist es möglich, eine eigene REST-Schnittstelle zur Verfügung zu stellen.

Methoden, die in der Schnittstelle verfügbar sein sollen, müssen als public deklariert werden. Rückgabewerte können beliebig festgelegt werden. Die URL für den Aufruf basiert auf folgenden Schema:

https:// **crm_url** /test/addon.php/ **Addon-Name** / **PfadZurRestKlasse**

Beispiel:

class myRestClass extends addon_rest
{
  public function get_list()
     {
        return true;
     }
}


Der dazu passende Aufruf:

include_once 'crm_rest_api.php';
$logon = new crm_rest_api("https://mycrm.de/rest/index.php/logon");
$session_id = $logon->crmLogin(array('username' => 'root', 'password' => ''));
 
$addon = new crm_rest_api("https://mycrm.de/rest/addon.php/helloworld/myRestClass");
$test = $addon->getDemo(array('session_id' => $session_id));
print_r($test);


Beachten Sie, dass immer ein Array übergeben werden muss, das mindestens den Key session_id enthält.

1. Methoden

1.1. return_error

Syntax:

void return_error($err_code, $err_message)

Beschreibung:

Mit dieser Methode kann eine Fehlermeldung zurückgegeben werden. Anschließend wird die weitere Ausführung abgebrochen.

Beispiel:

class myRestClass extends addon_rest
{
  public function get_list()
     {
         $this->return_error('1', 'My Error Message');
     }
}
  • No labels