API Example - LiveServices Delete

Problem

How do I delete (terminate) a live service using the Partner API?
Using the Partner RESTful API how to I delete a product (live service)?

Solution

The following example of code shows you how to delete a live service. The same technique is used for when terminating a service in a provisioning module.

Note, in order to delete a product you must first know the liveservice id. This can be optained by looking up the product and getting the liveservice id from the field name live_service_id.

Prerequisites

To use the Partner API you must meet the following criteria

Have a working development environment.
Have an active Partner account. If you need a partner account you can sign up here.
Enabled your account to use the API and set the access controls.
Have valid API Credentials.
Optional - Setup your development environment to initially use the Sandbox Testing Poral.

Example Code

The examples below use the sandbox for testing. For a production environment remember to change the following:

API Url
Partner ID
Partner API Key


<?php
/**
 *liveservices-del.php
 * 
 * This example will Delete a live service.  A live service is any of the
 * products made available in the portal (outMail, Profilter, fakeMX, 
 * backupMX, masterDNS and backupDNS).
 * 
 * You need to know the LiveService ID for the desired service you wish to 
 * delete.
 * 
 * For example, assuming you are trying to delete an outMail service
 * You can do a GET from /outmails, looking for the field name live_service_id. 
 * 
 * To Delete a service we use the /live_services end point in the API
 * 
 */
 
$apiPartnerId = "<PartnerID>";
$apiSecretKey = "___PartnerKey___";

$apiUrl       = "https://sandbox.my-engine.com/api-v1/live_services";

$crlf         = "<br />";

// Set the ID of the service to delete.
// Remember this is the live_service ID (live_service_id)
// If you're not sure then do a GET first and use the field live_service_id
$id = "1324938";

// Init Curl
$curl = curl_init();

// API Authentication:
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "$apiPartnerId:$apiSecretKey");

// Set Curl Options
curl_setopt($curl, CURLOPT_URL, $apiUrl . "$id");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

// API DELETE 
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE");
$jsonResult = curl_exec($curl);

// Check for a valid HTTP 200 success and process the returned result
// or handler the failure.
if (curl_getinfo($curl, CURLINFO_RESPONSE_CODE) == 200) {
    $result = json_decode($jsonResult, true);

    if (json_last_error() == JSON_ERROR_NONE)   {
        echo "status = " . $result["meta"]["success"] . $crlf;
    }
    
} else {
    echo "Response Code = " . curl_getinfo($curl, CURLINFO_RESPONSE_CODE) . $crlf;
    
    $result = json_decode($jsonResult, true);
    if (json_last_error() == JSON_ERROR_NONE)   {
        echo "error = " . $result["error"]["name"] . $crlf;
        echo "url = " . $result["error"]["url"] . $crlf;
        echo "message = " . $result["error"]["message"] . $crlf;
    } else {
        echo $jsonResult;
    }
}

curl_close($curl);


/**
 * liveservices-del.cs
 * 
 * This example will Delete a live service.  A live service is any of the
 * products made available in the portal (outMail, Profilter, fakeMX, 
 * backupMX, masterDNS and backupDNS).
 * 
 * You need to know the LiveService ID for the desired service you wish to 
 * delete.
 * 
 * For example, assuming you are trying to delete an outMail service
 * You can do a GET from /outmails, looking for the field name live_service_id. 
 * 
 * To Delete a service we use the /live_services end point in the API
 * 
 */

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

namespace liveservices_del
{
    class Program
    {
        private const string apiPartnerId = "<PartnerID>";
        private const string apiSecretKey = "_PartnerKey_";

        private const string apiUrl = "https://sandbox.my-engine.com/api-v1/live_services";

        static void Main(string[] args)
        {
            // Set the ID of the service to delete.
            // Remember this is the live_service ID (live_service_id)
            // If you're not sure then do a GET first and use the field live_service_id
            string id = "1324938";

            // Create HTTP resource
            HttpClient client = new HttpClient();
            client.BaseAddress = new Uri(apiUrl + "/" + id);

            // Add an Accept header for JSON format.
            client.DefaultRequestHeaders.Add("ContentType", "application/json");

            // Set the Authorisation
            var authToken = System.Text.Encoding.UTF8.GetBytes(apiPartnerId + ":" + apiSecretKey);
            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(authToken));

            // Do the DELETE
            var response = client.DeleteAsync(id).Result;

            // Check the result
            if (response.IsSuccessStatusCode)
            {
                var jsonResponseStr = response.Content.ReadAsStringAsync().Result;
                dynamic jsonResponse = JsonConvert.DeserializeObject(jsonResponseStr);
                if (jsonResponse.ContainsKey("meta"))
                {
                    Console.WriteLine("status = {0}", jsonResponse["meta"]["success"]);
                }
                else
                {
                    Console.WriteLine("response = {0}", response);
                    Console.WriteLine("json response = {0}", jsonResponse);
                }

                // Echo the result
                Console.WriteLine("response = {0}", response);
            }
            else
            {
                // Get the Json Error response and convert it
                var jsonResponseStr = response.Content.ReadAsStringAsync().Result;
                dynamic jsonResponse = JsonConvert.DeserializeObject(jsonResponseStr);
                Console.WriteLine("name = {0}", jsonResponse["error"]["name"]);
                Console.WriteLine("url = {0}", jsonResponse["error"]["url"]);
                Console.WriteLine("message = {0}", jsonResponse["error"]["message"]);
                Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
            }

            //Dispose once all HttpClient calls are complete.
            client.Dispose();
        }


    }
}


'
' liveservices-del.vb
' 
' This example will Delete a live service.  A live service Is any of the
' products made available in the portal (outMail, Profilter, fakeMX, 
' backupMX, masterDNS And backupDNS).
' 
' You need to know the LiveService ID for the desired service you wish to 
' delete.
' 
' For example, assuming you are trying to delete an outMail service
' You can do a GET from /outmails, looking for the field name live_service_id. 
' 
' To Delete a service we use the /live_services end point in the API
' 
'

Imports Newtonsoft.Json
Imports System
Imports System.Net.Http
Imports System.Net.Http.Headers

Module Program

    Private Const apiPartnerId As String = "<PartnerID>"
    Private Const apiSecretKey As String = "_PartnerKey_"

    Private Const apiUrl As String = "https://sandbox.my-engine.com/api-v1/live_services"

    Sub Main(args As String())

        ' Set the ID of the service to delete.
        ' Remember this Is the live_service ID (live_service_id)
        ' If you're not sure then do a GET first and use the field live_service_id
        Dim id As String = "1324938"

        ' Create HTTP resource
        Dim client As New HttpClient()
        client.BaseAddress = New Uri(apiUrl + "/" + id)

        ' Add an Accept header for JSON format.
        client.DefaultRequestHeaders.Add("ContentType", "application/json")

        ' Set the Authorisation
        Dim authToken = System.Text.Encoding.UTF8.GetBytes(apiPartnerId + ":" + apiSecretKey)
        client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(authToken))

        ' Do the DELETE
        Dim response As HttpResponseMessage = client.DeleteAsync(id).Result

        ' Check the result for a valid HTTP 200 success And process the returned result
        ' Or handler the failure.
        If (response.IsSuccessStatusCode) Then
            ' Get the created ID
            Dim jsonResponseStr = response.Content.ReadAsStringAsync().Result
            Dim jsonResponse As Object = JsonConvert.DeserializeObject(jsonResponseStr)
            If jsonResponse.ContainsKey("data") Then
                Console.WriteLine("status = {0}", jsonResponse("meta")("success"))
            Else
                Console.WriteLine("response = {0}", response)
                Console.WriteLine("json response = {0}", jsonResponse)
            End If
        Else
            ' Get the Json Error response And convert it
            Dim jsonResponseStr = response.Content.ReadAsStringAsync().Result
            Dim jsonResponse As Object = JsonConvert.DeserializeObject(jsonResponseStr)
            Console.WriteLine("name = {0}", jsonResponse("error")("name"))
            Console.WriteLine("url = {0}", jsonResponse("error")("url"))
            Console.WriteLine("message = {0}", jsonResponse("error")("message"))
            Console.WriteLine("{0} ({1})", response.StatusCode, response.ReasonPhrase)
        End If

        'Dispose once all HttpClient calls are complete.
        client.Dispose()

    End Sub

End Module


/**
 * liveservices-del.js
 * 
 * This example will Delete a live service.  A live service is any of the
 * products made available in the portal (outMail, Profilter, fakeMX, 
 * backupMX, masterDNS and backupDNS).
 * 
 * You need to know the LiveService ID for the desired service you wish to 
 * delete.
 * 
 * For example, assuming you are trying to delete an outMail service
 * You can do a GET from /outmails, looking for the field name live_service_id. 
 * 
 * To Delete a service we use the /live_services end point in the API
 * 
 */

var apiPartnerId = "<PartnerID>";
var apiSecretKey = "_PartnerKey_";

var apiUrl = "https://sandbox.my-engine.com/api-v1/live_services";

// Set the ID of the service to delete.
// Remember this is the live_service ID (live_service_id)
// If you're not sure then do a GET first and use the field live_service_id
var id = "1324938";


// Setup the Ajax request
var settings = {
    url: apiUrl + '/' + id,
    headers: {
        'Authorization': 'Basic ' + btoa(apiPartnerId + ":" + apiSecretKey),
        'cache-control': 'no-cache'
    },
    crossDomain: true,
    dataType: 'json',
    async: true,
    method: "DELETE"
};

// API PATCH
$.ajax(settings)
    .done(function(response) {
        console.log("status = " + response.meta.success);
        console.log(" ");

    })
    .fail(function(request, textStatus, errorThrown) {
        try {
            var errObj = $.parseJSON(request.responseText);
            console.log("API Error - " + errObj.name);
            console.log("API Msg   - " + errObj.message);
            console.log("API url   - " + errObj.url);
        } catch (e) {
            console.log("Error - " + errorThrown);
            console.log("Status - " + request.status);
            console.log(request);
        }
    });

API Example - LiveServices Delete

Problem

Solution

Prerequisites

Example Code

Did you enjoy this article?

Disclaimer

Email Services

Internet Services

Resources

Company

Search

API Example - LiveServices Delete

Problem

Solution

Prerequisites

Example Code

Did you enjoy this article?

Disclaimer