Exigo Web Services API v3.4.179

DeleteWebCategory

Deletes a web category.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

DeleteWebCategoryRequest
PropertyData TypeNotes
WebIDInt32WebID used in content engine.
CategoryIDInt32

Output Properties

DeleteWebCategoryResponse
PropertyData TypeNotes
CategoryIDInt32
WebIDInt32WebID used in content engine.

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/DeleteWebCategory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> </ApiAuthentication> </soap:Header> <soap:Body> <DeleteWebCategoryRequest xmlns="http://api.exigo.com/"> <WebID>int</WebID> <CategoryID>int</CategoryID> </DeleteWebCategoryRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <DeleteWebCategoryResult xmlns="http://api.exigo.com/"> <CategoryID>int</CategoryID> <WebID>int</WebID> </DeleteWebCategoryResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    DeleteWebCategoryRequest req = new DeleteWebCategoryRequest();

 

    req.WebID = 1;                  //WebID used in content engine

    req.CategoryID = 1;

 

    //Send Request to Server and Get Response

    DeleteWebCategoryResponse res = api.DeleteWebCategory(req);

 

    //Now examine the results:

    Console.WriteLine("CategoryID: {0}", res.CategoryID);

    Console.WriteLine("WebID: {0}", res.WebID);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new DeleteWebCategoryRequest()

 

    req.WebID = 1

    req.CategoryID = 1

 

    'Send Request to Server and Get Response

    Dim res As DeleteWebCategoryResponse = api.DeleteWebCategory(req)

 

    'Now examine the results:

    Console.WriteLine("CategoryID: {0}", res.CategoryID)

    Console.WriteLine("WebID: {0}", res.WebID)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->WebID = 1;

    $req->CategoryID = 1;

 

    //Send Request to Server and Get Response

    $res = $api.DeleteWebCategory($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    DeleteWebCategoryRequest req = new DeleteWebCategoryRequest();

 

    req.setWebID(1);

    req.setCategoryID(1);

 

    //Send Request to Server and Get Response

    DeleteWebCategoryResponse res = api.getExigoApiSoap().deleteWebCategory(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.