Skip to main content

API

Module: ConnectWise-Manage-API​

\public_html\modules\custom\ConnectWise_Module_API
*
|______ConnectWise_Module_api.info.yml
|
|______ConnectWise_Module_api.routing.yml
|
|______\src
    |
    |_______\Controller
                    |_______JsonApi_Company.php
                    |_______JsonApi_RequestProxy.php
                    |_______JsonApi_Tickets.php
                    |_______JsonApi_TimeEntries_currentMonth.php
                    |_______JsonApi_TimeEntries_withCalc.php
                    |_______JsonApi_TimeEntries.php
                    |_______JsonApi_getCompanyIdentifier_
                                        \fromUserField.php

For the above file/directories

  • \ ConnectWise_Module_API  :
    • Directory containing the custom module.
  • ConnectWise_Module_api.info.yml:
    • The file of which lets drupal know of this custom module, the drupal PHP will get the fields "machine name", "description", "package", "compatible drupal version" from this file.
    • More information. 
  • ConnectWise_Module_api.routing.yml:
    • The router of the drupal module, mapping a path like "/page/hello_world" to some callback of controller say "/Drupal/example/ControllerExample::page_hello_world_controller"; This file also defines the type of output (json/html), the permission, and library to load (e.g. javascript, CSS) for this page.
    •  More information. 
  • \src\Controller
    • The handler / callback for the router, it is the processing logic of the page; This file takes the parameter from the router, adds a header and returns the page body.
    •  More information.