Get addons

Get all addons matching the following parameters


Endpoint


Method URI
POST https://apiv2.keliweb.it/api/v2/keliweb/get-clients-addons

Request Parameters


Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Required
serviceid integer The service id(s) to obtain the client product addons for. Single number or comma separated list Required
addonid integer The predefined addon id to obtain the client product addons for Optional

Response Parameters


Parameter Type Description
result string The result of the operation: success or error
totalresults integer The total number of results available
serviceid integer The specific service id searched for
clientid integer The specific client id searched for
addons array The client product addons list

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-clients-addons",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'clientid'  => '1'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("clientid", "1");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-clients-addons",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                {
                    "result"                           : "success",
                    "serviceid"                        : "",
                    "clientid"                         : "1",
                    "totalresults"                     : "1",
                    "addons[addon][0][id]"             : "1",
                    "addons[addon][0][userid]"         : "1",
                    "addons[addon][0][orderid]"        : "0",
                    "addons[addon][0][serviceid]"      : "1",
                    "addons[addon][0][addonid]"        : "0",
                    "addons[addon][0][name]"           : "Addon 1",
                    "addons[addon][0][setupfee]"       : "0.00",
                    "addons[addon][0][recurring]"      : "15.00",
                    "addons[addon][0][billingcycle]"   : "Monthly",
                    "addons[addon][0][tax]"            : "",
                    "addons[addon][0][status]"         : "Active",
                    "addons[addon][0][regdate]"        : "2015-12-03",
                    "addons[addon][0][nextduedate]"    : "2016-10-03",
                    "addons[addon][0][nextinvoicedate]": "2016-10-03",
                    "addons[addon][0][paymentmethod]"  : "paypal",
                    "addons[addon][0][notes]"          : ""
                }